|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectSpatialIndexFeatureCollection
public class SpatialIndexFeatureCollection
FeatureCollection used to stage information for display using a SpatialIndex.
Please note that this feature collection cannot be modified after the spatial index is created.
Field Summary | |
---|---|
protected STRtree |
index
SpatialIndex holding the contents of the FeatureCollection |
protected List<CollectionListener> |
listeners
Listeners |
protected SimpleFeatureType |
schema
|
Constructor Summary | |
---|---|
SpatialIndexFeatureCollection()
|
|
SpatialIndexFeatureCollection(SimpleFeatureCollection copy)
|
|
SpatialIndexFeatureCollection(SimpleFeatureType schema)
|
Method Summary | ||
---|---|---|
void |
accepts(FeatureVisitor visitor,
ProgressListener listener)
Visit the contents of a feature collection. |
|
boolean |
add(SimpleFeature feature)
|
|
boolean |
addAll(Collection<? extends SimpleFeature> collection)
|
|
boolean |
addAll(FeatureCollection<? extends SimpleFeatureType,? extends SimpleFeature> collection)
|
|
void |
addListener(CollectionListener listener)
|
|
void |
clear()
|
|
void |
close(FeatureIterator<SimpleFeature> close)
|
|
void |
close(Iterator<SimpleFeature> close)
|
|
boolean |
contains(Object obj)
|
|
boolean |
containsAll(Collection<?> collection)
|
|
SimpleFeatureIterator |
features()
Obtain a SimpleFeatureIterator of the Features within this SimpleFeatureCollection. |
|
protected void |
fire(SimpleFeature[] features,
int eventType)
|
|
ReferencedEnvelope |
getBounds()
Get the total bounds of this collection which is calculated by doing a union of the bounds of each feature inside of it |
|
String |
getID()
ID used when serializing to GML |
|
SimpleFeatureType |
getSchema()
The schema for the child feature members of this collection. |
|
boolean |
isEmpty()
Returns true if this feature collection contains no features. |
|
Iterator<SimpleFeature> |
iterator()
|
|
void |
purge()
|
|
boolean |
remove(Object o)
|
|
boolean |
removeAll(Collection<?> c)
|
|
void |
removeListener(CollectionListener listener)
|
|
boolean |
retainAll(Collection<?> c)
|
|
int |
size()
Will build the STRtree index if required. |
|
SimpleFeatureCollection |
sort(SortBy order)
Obtained sorted contents. |
|
SimpleFeatureCollection |
subCollection(Filter filter)
SimpleFeatureCollection "view" indicated by provided filter. |
|
Object[] |
toArray()
|
|
|
toArray(O[] array)
|
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected STRtree index
protected SimpleFeatureType schema
protected List<CollectionListener> listeners
Constructor Detail |
---|
public SpatialIndexFeatureCollection()
public SpatialIndexFeatureCollection(SimpleFeatureType schema)
public SpatialIndexFeatureCollection(SimpleFeatureCollection copy) throws IOException
IOException
Method Detail |
---|
public void addListener(CollectionListener listener) throws NullPointerException
NullPointerException
public void removeListener(CollectionListener listener) throws NullPointerException
NullPointerException
protected void fire(SimpleFeature[] features, int eventType)
public SimpleFeatureIterator features()
SimpleFeatureCollection
The implementation of FeatureIterator must adhere to the rules of
fail-fast concurrent modification. In addition (to allow for
resource backed collections) the SimpleFeatureIterator.close()
method must be called.
Example use:
SimpleFeatureIterator iterator=collection.features();
try {
while( iterator.hasNext() ){
SimpleFeature feature = iterator.next();
System.out.println( feature.getID() );
}
}
finally {
iterator.close();
}
features
in interface SimpleFeatureCollection
features
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
public SimpleFeatureCollection sort(SortBy order)
FeatureCollection
This method may not be supported by all implementations, consider the use of FeatureSource.features( Query ).
sort
in interface SimpleFeatureCollection
sort
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
order
- Sort order
public SimpleFeatureCollection subCollection(Filter filter)
FeatureCollection
The contents of the returned SimpleFeatureCollection are determined by applying the provider Filter to the entire contents of this FeatureCollection. The result is "live" and modifications will be shared.
This method is used cut down on the number of filter based methods required for a useful SimpleFeatureCollection construct. The FeatureCollections returned really should be considered as a temporary "view" used to control the range of a removeAll, or modify operation.
Example Use:
collection.subCollection( filter ).clear();
The above recommended use is agreement with the Collections API precident of
List.subList( start, end ).
The results of subCollection:
subCollection
in interface SimpleFeatureCollection
subCollection
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
FeatureList
public void accepts(FeatureVisitor visitor, ProgressListener listener) throws IOException
FeatureCollection
The order of traversal is dependent on the FeatureCollection implementation; some collections are able to make efficient use of an internal index in order to quickly visit features located in the same region.
accepts
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
visitor
- Closure applied to each feature in turn.listener
- Used to report progress, may be used to interrupt the operation
IOException
public boolean add(SimpleFeature feature)
public boolean addAll(Collection<? extends SimpleFeature> collection)
public boolean addAll(FeatureCollection<? extends SimpleFeatureType,? extends SimpleFeature> collection)
public void clear()
public void close(FeatureIterator<SimpleFeature> close)
public void close(Iterator<SimpleFeature> close)
public boolean contains(Object obj)
contains
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Collection.contains(Object)
public boolean containsAll(Collection<?> collection)
containsAll
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Collection.containsAll(Collection)
public ReferencedEnvelope getBounds()
FeatureCollection
getBounds
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
public String getID()
FeatureCollection
getID
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
public SimpleFeatureType getSchema()
FeatureCollection
Represents the most general FeatureType in common to all the features in this collection.
getSchema
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
public boolean isEmpty()
FeatureCollection
isEmpty
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
public Iterator<SimpleFeature> iterator()
public void purge()
public boolean remove(Object o)
public boolean removeAll(Collection<?> c)
public boolean retainAll(Collection<?> c)
public int size()
size
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Collection.size()
public Object[] toArray()
toArray
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Collection.toArray()
public <O> O[] toArray(O[] array)
toArray
in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Collection.toArray(Object[])
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |