|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.geotools.feature.collection.DecoratingFeatureCollection<T,F>
public class DecoratingFeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
A FeatureCollection which completley delegates to another FeatureCollection.
This class should be subclasses by classes which must somehow decorate
another FeatureCollection
Field Summary | |
---|---|
protected FeatureCollection<T,F> |
delegate
the delegate |
Constructor Summary | |
---|---|
protected |
DecoratingFeatureCollection(FeatureCollection<T,F> delegate)
|
Method Summary | |
---|---|
void |
accepts(FeatureVisitor visitor,
ProgressListener progress)
|
void |
accepts(org.opengis.feature.FeatureVisitor visitor,
org.opengis.util.ProgressListener progress)
Visit the contents of a feature collection. |
boolean |
add(F o)
Add object to this collection. |
boolean |
addAll(java.util.Collection c)
Add all the objects to the collection. |
boolean |
addAll(FeatureCollection c)
|
void |
addListener(CollectionListener listener)
Adds a listener for collection events. |
void |
clear()
|
void |
close(FeatureIterator<F> close)
Clean up after any resources associated with this FeatureIterator in a manner similar to JDO collections. |
void |
close(java.util.Iterator<F> close)
Clean up after any resources associated with this itterator in a manner similar to JDO collections. |
boolean |
contains(java.lang.Object o)
|
boolean |
containsAll(java.util.Collection c)
|
boolean |
equals(java.lang.Object o)
|
FeatureIterator<F> |
features()
Obtain a FeatureIterator |
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 |
java.lang.String |
getID()
ID used when serializing to GML |
T |
getSchema()
The schema for the child features of this collection. |
int |
hashCode()
|
boolean |
isEmpty()
|
java.util.Iterator |
iterator()
An iterator over this collection, which must be closed after use. |
void |
purge()
Close any outstanding resources released by this resources. |
boolean |
remove(java.lang.Object o)
|
boolean |
removeAll(java.util.Collection c)
|
void |
removeListener(CollectionListener listener)
Removes a listener for collection events. |
boolean |
retainAll(java.util.Collection c)
|
int |
size()
|
FeatureCollection<T,F> |
sort(org.opengis.filter.sort.SortBy order)
collection.subCollection( myFilter ).sort( {"foo","bar"} ); collection.subCollection( myFilter ).sort( "bar" ).sort("foo") |
FeatureCollection<T,F> |
subCollection(org.opengis.filter.Filter filter)
FeatureCollection |
java.lang.Object[] |
toArray()
|
java.lang.Object[] |
toArray(java.lang.Object[] a)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature> delegate
Constructor Detail |
---|
protected DecoratingFeatureCollection(FeatureCollection<T,F> delegate)
Method Detail |
---|
public void accepts(FeatureVisitor visitor, ProgressListener progress) throws java.io.IOException
java.io.IOException
public void accepts(org.opengis.feature.FeatureVisitor visitor, org.opengis.util.ProgressListener progress) throws java.io.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<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
visitor
- Closure applied to each feature in turn.progress
- Used to report progress, may be used to interrupt the operation
java.io.IOException
public boolean add(F o)
FeatureCollection
This method is often not impelmented for collections produced as the result of a query.
add
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.add(Object)
public boolean addAll(java.util.Collection c)
FeatureCollection
This method is often not implemented for collections produced as the results of a query.
addAll
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.addAll(Collection)
public boolean addAll(FeatureCollection c)
addAll
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
FeatureCollection.addAll(Collection)
public void addListener(CollectionListener listener) throws java.lang.NullPointerException
FeatureCollection
When this collection is backed by live data the event notification will follow the guidelines outlined by FeatureListner.
addListener
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
listener
- The listener to add
java.lang.NullPointerException
- If the listener is null.public void clear()
clear
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.clear()
public void close(FeatureIterator<F> close)
FeatureCollection
Iterator iterator = collection.iterator();
try {
for( Iterator i=collection.iterator(); i.hasNext();){
Feature feature = i.hasNext();
System.out.println( feature.getID() );
}
}
finally {
collection.close( iterator );
}
close
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
public void close(java.util.Iterator<F> close)
FeatureCollection
Iterator iterator = collection.iterator();
try {
for( Iterator i=collection.iterator(); i.hasNext();){
Feature feature = (Feature) i.hasNext();
System.out.println( feature.getID() );
}
}
finally {
collection.close( iterator );
}
close
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
public boolean contains(java.lang.Object o)
contains
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.contains(Object)
public boolean containsAll(java.util.Collection c)
containsAll
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.containsAll(Collection)
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public FeatureIterator<F> features()
FeatureCollection
The implementation of Collection must adhere to the rules of
fail-fast concurrent modification. In addition (to allow for
resource backed collections, the close( Iterator )
method must be called.
This is almost equivalent to:
getAttribute(getFeatureType().getAttributeType(0).getName()).iterator();
.
Iterator<Feature>
FeatureIterator iterator=collection.features();
try {
while( iterator.hasNext() ){
Feature feature = iterator.next();
System.out.println( feature.getID() );
}
}
finally {
collection.close( iterator );
}
GML Note: The contents of this iterator are considered to be defined by featureMember tags (and/or the single allowed FeatureMembers tag). Please see getFeatureType for more details.
features
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
public ReferencedEnvelope getBounds()
FeatureCollection
getBounds
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
public T getSchema()
FeatureCollection
There is a difference between getFeatureType() and getSchema()represents the LCD FeatureType that best represents the contents of this collection.
The method getSchema() is named for compatability with the geotools 2.0 API. In the Geotools 2.2 time frame we should be able to replace this method with a careful check of getFeatureType() and its attributes.
getSchema
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
public int hashCode()
hashCode
in class java.lang.Object
public boolean isEmpty()
isEmpty
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.isEmpty()
public java.util.Iterator iterator()
FeatureCollection
Collection is not guaranteed to be ordered in any manner.
The implementation of Collection must adhere to the rules of
fail-fast concurrent modification. In addition (to allow for
resource backed collections, the close( Iterator )
method must be called.
Example (safe) use:
Iterator iterator = collection.iterator();
try {
while( iterator.hasNext();){
Feature feature = (Feature) iterator.hasNext();
System.out.println( feature.getID() );
}
}
finally {
collection.close( iterator );
}
iterator
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
public void purge()
FeatureCollection
This method should be used with great caution, it is however available to allow the use of the ResourceCollection with algorthims that are unaware of the need to close iterators after use.
Example of using a normal Collections utility method:
Collections.sort( collection );
collection.purge();
purge
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
public boolean remove(java.lang.Object o)
remove
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.remove(Object)
public boolean removeAll(java.util.Collection c)
removeAll
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.removeAll(Collection)
public void removeListener(CollectionListener listener) throws java.lang.NullPointerException
FeatureCollection
removeListener
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
listener
- The listener to remove
java.lang.NullPointerException
- If the listener is null.public boolean retainAll(java.util.Collection c)
retainAll
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.retainAll(Collection)
public int size()
size
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.size()
public FeatureCollection<T,F> sort(org.opengis.filter.sort.SortBy order)
FeatureCollection
sort
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
public FeatureCollection<T,F> subCollection(org.opengis.filter.Filter filter)
FeatureCollection
The contents of the returned FeatureCollection
This method is used cut down on the number of filter based methods
required for a useful FeatureCollection
Example Use:
The results of subCollection:
The above recommended use is agreement with the Collections API precident of
List.subList( start, end ).
collection.subCollection( filter ).clear();
subCollection
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
FeatureList
public java.lang.Object[] toArray()
toArray
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.toArray()
public java.lang.Object[] toArray(java.lang.Object[] a)
toArray
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
Collection.toArray(Object[])
public java.lang.String getID()
FeatureCollection
getID
in interface FeatureCollection<T extends org.opengis.feature.type.FeatureType,F extends org.opengis.feature.Feature>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |