| java.lang.Object
 org.geotools.feature.DefaultFeatureCollection
All known Subclasses: org.geotools.xml.gml.GMLFeatureCollection,
| DefaultFeatureCollection | | public class DefaultFeatureCollection implements FeatureCollection(Code) | | A basic implementation of FeatureCollection which use a
TreeMap for
its internal storage.
This should be considered a MemoryFeatureCollection.
author:
Ian Schneider
version:
$Id: DefaultFeatureCollection.java 27905 2007-11-15 08:51:13Z desruisseaux $ |
| Constructor Summary | |
| public | DefaultFeatureCollection(String id, FeatureType featureType)
This contructor should not be used by client code.
Opportunistic reuse is encouraged, but only for the purposes
of testing or other specialized uses. |
| Method Summary | |
| public void | accepts(FeatureVisitor visitor, ProgressListener progress)
Accepts a visitor, which then visits each feature in the collection. | | public boolean | add(Object o)
Ensures that this collection contains the specified element (optional
operation). | | protected boolean | add(Feature feature, boolean fire)
| | public boolean | addAll(Collection collection)
Adds all of the elements in the specified collection to this collection
(optional operation). | | public void | addListener(CollectionListener listener)
Adds a listener for collection events. | | public void | clear()
Removes all of the elements from this collection (optional operation). | | public void | close(FeatureIterator close)
| | public void | close(Iterator close)
| | public FeatureCollection | collection()
| | public boolean | contains(Object o)
Returns true if this collection contains the specified element.
More formally, returns true if and only if this collection
contains at least one element e such that (o==null ?
e==null : o.equals(e)).
Parameters:
o - element whose presence in this collection is to be tested. | | public boolean | containsAll(Collection collection)
Test for collection membership. | | public FeatureIterator | features()
Gets a FeatureIterator of this feature collection. | | public Set | fids()
Optimization time ... | | protected void | fireChange(Feature[] features, int type)
To let listeners know that something has changed. | | protected void | fireChange(Feature feature, int type)
| | protected void | fireChange(Collection coll, int type)
| | public Object | getAttribute(String xPath)
| | public Object | getAttribute(int index)
| | public Object[] | getAttributes(Object[] attributes)
| | public ReferencedEnvelope | getBounds()
Gets the bounding box for the features in this feature collection. | | public int | getCount()
| | public Geometry | getDefaultGeometry()
| | public FeatureType | getFeatureType()
| | public String | getID()
| | public int | getNumberOfAttributes()
| | public FeatureCollection | getParent()
| | public FeatureType | getSchema()
| | public boolean | isEmpty()
Returns true if this collection contains no elements. | | public Iterator | iterator()
Returns an iterator over the elements in this collection. | | public void | purge()
| | public FeatureReader | reader()
| | public boolean | remove(Object o)
Removes a single instance of the specified element from this collection,
if it is present (optional operation). | | public boolean | removeAll(Collection collection)
Removes all this collection's elements that are also contained in the
specified collection (optional operation). | | public void | removeListener(CollectionListener listener)
Removes a listener for collection events. | | public boolean | retainAll(Collection collection)
Retains only the elements in this collection that are contained in the
specified collection (optional operation). | | public void | setAttribute(int position, Object val)
| | public void | setAttribute(String xPath, Object attribute)
| | public void | setDefaultGeometry(Geometry geometry)
| | public void | setParent(FeatureCollection collection)
| | public int | size()
Returns the number of elements in this collection. | | public FeatureList | sort(SortBy order)
Construct a sorted view of this content. | | public FeatureList | sort(SortBy2 order)
Allows for "Advanced" sort capabilities specific to the
GeoTools platform!
Advanced in this case really means making use of a generic
Expression, rather then being limited to PropertyName. | | public FeatureCollection | subCollection(Filter filter)
Will return an optimized subCollection based on access
to the origional MemoryFeatureCollection. | | public Object[] | toArray()
Returns an array containing all of the elements in this collection. | | public Object[] | toArray(Object[] a)
Returns an array containing all of the elements in this collection; the
runtime type of the returned array is that of the specified array. |
| DefaultFeatureCollection | | public DefaultFeatureCollection(String id, FeatureType featureType)(Code) | | This contructor should not be used by client code.
Opportunistic reuse is encouraged, but only for the purposes
of testing or other specialized uses. Normal creation should
occur through org.geotools.core.FeatureCollections.newCollection()
allowing applications to customize any generated collections.
Parameters:
id - may be null ... feature id
Parameters:
featureType - optional, may be null |
| add | | public boolean add(Object o)(Code) | | Ensures that this collection contains the specified element (optional
operation). Returns true if this collection changed as a
result of the call. (Returns false if this collection does
not permit duplicates and already contains the specified element.)
Collections that support this operation may place limitations on what
elements may be added to this collection. In particular, some
collections will refuse to add null elements, and others will
impose restrictions on the type of elements that may be added.
Collection classes should clearly specify in their documentation any
restrictions on what elements may be added.
If a collection refuses to add a particular element for any reason other
than that it already contains the element, it must throw an
exception (rather than returning false). This preserves the
invariant that a collection always contains the specified element after
this call returns.
Parameters:
o - element whose presence in this collection is to be ensured. true if this collection changed as a result of the call |
| addAll | | public boolean addAll(Collection collection)(Code) | | Adds all of the elements in the specified collection to this collection
(optional operation). The behavior of this operation is undefined if
the specified collection is modified while the operation is in
progress. (This implies that the behavior of this call is undefined if
the specified collection is this collection, and this collection is
nonempty.)
Parameters:
collection - elements to be inserted into this collection. true if this collection changed as a result of the call
See Also: DefaultFeatureCollection.add(Object) |
| addListener | | public void addListener(CollectionListener listener)(Code) | | Adds a listener for collection events.
Parameters:
listener - The listener to add |
| clear | | public void clear()(Code) | | Removes all of the elements from this collection (optional operation).
This collection will be empty after this method returns unless it
throws an exception.
|
| contains | | public boolean contains(Object o)(Code) | | Returns true if this collection contains the specified element.
More formally, returns true if and only if this collection
contains at least one element e such that (o==null ?
e==null : o.equals(e)).
Parameters:
o - element whose presence in this collection is to be tested. true if this collection contains the specified element |
| containsAll | | public boolean containsAll(Collection collection)(Code) | | Test for collection membership.
Parameters:
collection - true if collection is completly covered |
| features | | public FeatureIterator features()(Code) | | Gets a FeatureIterator of this feature collection. This allows
iteration without having to cast.
the FeatureIterator for this collection. |
| fids | | public Set fids()(Code) | | Optimization time ... grab the fid set so other can quickly test membership
during removeAll/retainAll implementations.
Set of fids. |
| fireChange | | protected void fireChange(Feature[] features, int type)(Code) | | To let listeners know that something has changed.
|
| fireChange | | protected void fireChange(Feature feature, int type)(Code) | | |
| getBounds | | public ReferencedEnvelope getBounds()(Code) | | Gets the bounding box for the features in this feature collection.
the envelope of the geometries contained by this featurecollection. |
| getDefaultGeometry | | public Geometry getDefaultGeometry()(Code) | | |
| getNumberOfAttributes | | public int getNumberOfAttributes()(Code) | | |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if this collection contains no elements.
true if this collection contains no elements |
| iterator | | public Iterator iterator()(Code) | | Returns an iterator over the elements in this collection. There are no
guarantees concerning the order in which the elements are returned
(unless this collection is an instance of some class that provides a
guarantee).
an Iterator over the elements in this collection |
| purge | | public void purge()(Code) | | |
| remove | | public boolean remove(Object o)(Code) | | Removes a single instance of the specified element from this collection,
if it is present (optional operation). More formally, removes an
element e such that (o==null ? e==null :
o.equals(e)), if this collection contains one or more such
elements. Returns true if this collection contained the specified
element (or equivalently, if this collection changed as a result of the
call).
Parameters:
o - element to be removed from this collection, if present. true if this collection changed as a result of the call |
| removeAll | | public boolean removeAll(Collection collection)(Code) | | Removes all this collection's elements that are also contained in the
specified collection (optional operation). After this call returns,
this collection will contain no elements in common with the specified
collection.
Parameters:
collection - elements to be removed from this collection. true if this collection changed as a result of the call
See Also: DefaultFeatureCollection.remove(Object)
See Also: DefaultFeatureCollection.contains(Object) |
| removeListener | | public void removeListener(CollectionListener listener)(Code) | | Removes a listener for collection events.
Parameters:
listener - The listener to remove |
| retainAll | | public boolean retainAll(Collection collection)(Code) | | Retains only the elements in this collection that are contained in the
specified collection (optional operation). In other words, removes
from this collection all of its elements that are not contained in the
specified collection.
Parameters:
collection - elements to be retained in this collection. true if this collection changed as a result of the call
See Also: DefaultFeatureCollection.remove(Object)
See Also: DefaultFeatureCollection.contains(Object) |
| size | | public int size()(Code) | | Returns the number of elements in this collection. If this collection
contains more than Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.
the number of elements in this collection |
| sort | | public FeatureList sort(SortBy order)(Code) | | Construct a sorted view of this content.
Sorts may be combined togther in a stable fashion, in congruence
with the Filter 1.1 specification.
This method should also be able to handle GeoTools specific
sorting through detecting order as a SortBy2 instance.
since:
GeoTools 2.2, Filter 1.1
Parameters:
order - Filter 1.1 SortBy Construction of a Sort FeatureList sorted according to provided order |
| sort | | public FeatureList sort(SortBy2 order)(Code) | | Allows for "Advanced" sort capabilities specific to the
GeoTools platform!
Advanced in this case really means making use of a generic
Expression, rather then being limited to PropertyName.
Parameters:
order - GeoTools SortBy FeatureList sorted according to provided order |
| subCollection | | public FeatureCollection subCollection(Filter filter)(Code) | | Will return an optimized subCollection based on access
to the origional MemoryFeatureCollection.
This method is intended in a manner similar to subList,
example use:
collection.subCollection( myFilter ).clear()
Parameters:
filter - Filter used to determine sub collection.
since:
GeoTools 2.2, Filter 1.1 |
| toArray | | public Object[] toArray()(Code) | | Returns an array containing all of the elements in this collection. If
the collection makes any guarantees as to what order its elements are
returned by its iterator, this method must return the elements in the
same order.
The returned array will be "safe" in that no references to it are
maintained by this collection. (In other words, this method must
allocate a new array even if this collection is backed by an array).
The caller is thus free to modify the returned array.
This method acts as bridge between array-based and collection-based
APIs.
an array containing all of the elements in this collection |
| toArray | | public Object[] toArray(Object[] a)(Code) | | Returns an array containing all of the elements in this collection; the
runtime type of the returned array is that of the specified array. If
the collection fits in the specified array, it is returned therein.
Otherwise, a new array is allocated with the runtime type of the
specified array and the size of this collection.
If this collection fits in the specified array with room to spare (i.e.,
the array has more elements than this collection), the element in the
array immediately following the end of the collection is set to
null. This is useful in determining the length of this
collection only if the caller knows that this collection does
not contain any null elements.)
If this collection makes any guarantees as to what order its elements
are returned by its iterator, this method must return the elements in
the same order.
Like the toArray method, this method acts as bridge between
array-based and collection-based APIs. Further, this method allows
precise control over the runtime type of the output array, and may,
under certain circumstances, be used to save allocation costs
Suppose l is a List known to contain only strings. The
following code can be used to dump the list into a newly allocated
array of String:
String[] x = (String[]) v.toArray(new String[0]);
Note that toArray(new Object[0]) is identical in function to
toArray().
Parameters:
a - the array into which the elements of this collection are to bestored, if it is big enough; otherwise, a new array of the sameruntime type is allocated for this purpose. an array containing the elements of this collection |
|
|