Class PirolFeatureCollection
- java.lang.Object
-
- org.openjump.core.apitools.objecttyperoles.PirolFeatureCollection
-
- All Implemented Interfaces:
FeatureCollection
,ObjectContainingMetaInformation
public class PirolFeatureCollection extends Object implements FeatureCollection, ObjectContainingMetaInformation
Class that wraps a FeatureDataset and adds methods to get and set meta information objects.- Version:
- $Rev: 1654 $
- Author:
- Ole Rahn
FH Osnabrück - University of Applied Sciences Osnabrück,
Project: PIROL (2005),
Subproject: Daten- und Wissensmanagement - See Also:
MetaInformationHandler.createPirolFeatureCollection(FeatureCollection)
-
-
Field Summary
Fields Modifier and Type Field Description protected FeatureCollection
featureDataSet
protected MetaDataMap
metaInformation
protected FeatureCollectionRole[]
roles
-
Constructor Summary
Constructors Constructor Description PirolFeatureCollection()
Constructor - for java2xml, only!!PirolFeatureCollection(FeatureCollection featureDataSet, FeatureCollectionRole initRole)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(Feature feature)
Adds a feature to this collection.void
addAll(Collection features)
Adds multiple features to this collection.void
addRole(FeatureCollectionRole role)
void
addXmlRole(FeatureCollectionRole role)
for java2xmlvoid
clear()
Removes all features from this collection.boolean
equals(Object arg0)
protected void
finalize()
org.locationtech.jts.geom.Envelope
getEnvelope()
Returns the bounds of this collection.FeatureCollection
getFeatureDataSet()
for java2xmlList
getFeatures()
Returns an unmodifiable List of the features in this collectionFeatureSchema
getFeatureSchema()
Returns information about this FeatureCollectionMetaDataMap
getMetaInformation()
FeatureCollectionRole
getRole(int roleId)
Check if this FeatureCollection has a role with the given IDFeatureCollectionRole
getRole(FeatureCollectionRole role)
Check if this FeatureCollection has a role like the given oneFeatureCollectionRole
getRole(FeatureCollectionRoleTypes role)
Check if this FeatureCollection has a role like the given oneFeatureCollectionRole[]
getRoles()
FeatureCollection
getWrappee()
the PirolFeatureCollection is a wrapper for other feature collections in some cases one might want to work with the original FC.Collection
getXmlRoles()
for java2xmlint
hashCode()
void
invalidateEnvelope(boolean simpleInvalidation)
boolean
isEmpty()
Returns whether this collection has no features.Iterator
iterator()
Returns an Iterator over the featuresList
query(org.locationtech.jts.geom.Envelope envelope)
A quick search for features, using an envelope comparison.void
remove(Feature feature)
Removes a feature from this collection.Collection
remove(org.locationtech.jts.geom.Envelope env)
Removes the features which intersect the given envelopevoid
removeAll(Collection features)
Removes multiple features from this collection.void
removeRole(FeatureCollectionRole role)
void
setFeatureDataSet(FeatureCollection featureDataSet)
for java2xmlvoid
setMetaInformation(MetaDataMap metaInformation)
int
size()
Returns the number of features in this collection.Feature[]
toArray()
String
toString()
-
-
-
Field Detail
-
featureDataSet
protected FeatureCollection featureDataSet
-
metaInformation
protected MetaDataMap metaInformation
-
roles
protected FeatureCollectionRole[] roles
-
-
Constructor Detail
-
PirolFeatureCollection
public PirolFeatureCollection(FeatureCollection featureDataSet, FeatureCollectionRole initRole)
-
PirolFeatureCollection
public PirolFeatureCollection()
Constructor - for java2xml, only!!
-
-
Method Detail
-
getXmlRoles
public Collection getXmlRoles()
for java2xml
-
addXmlRole
public void addXmlRole(FeatureCollectionRole role)
for java2xml
-
getFeatureDataSet
public FeatureCollection getFeatureDataSet()
for java2xml
-
setFeatureDataSet
public void setFeatureDataSet(FeatureCollection featureDataSet)
for java2xml
-
addRole
public void addRole(FeatureCollectionRole role)
-
removeRole
public void removeRole(FeatureCollectionRole role)
-
getRoles
public FeatureCollectionRole[] getRoles()
-
getRole
public FeatureCollectionRole getRole(FeatureCollectionRole role)
Check if this FeatureCollection has a role like the given one- Parameters:
role
- the role to check for- Returns:
- the role if this FeatureCollection has a role like the given one, else null
- See Also:
FeatureCollectionRoleTypes
-
getRole
public FeatureCollectionRole getRole(FeatureCollectionRoleTypes role)
Check if this FeatureCollection has a role like the given one- Parameters:
role
- the role to check for- Returns:
- the role if this FeatureCollection has a role like the given one, else null
- See Also:
FeatureCollectionRoleTypes
-
getRole
public FeatureCollectionRole getRole(int roleId)
Check if this FeatureCollection has a role with the given ID- Parameters:
roleId
- id of the role type to check for- Returns:
- the role if this FeatureCollection has a role with the given ID, else null
- See Also:
FeatureCollectionRoleTypes
-
getMetaInformation
public MetaDataMap getMetaInformation()
- Specified by:
getMetaInformation
in interfaceObjectContainingMetaInformation
-
setMetaInformation
public void setMetaInformation(MetaDataMap metaInformation)
- Specified by:
setMetaInformation
in interfaceObjectContainingMetaInformation
-
invalidateEnvelope
public void invalidateEnvelope(boolean simpleInvalidation)
-
add
public void add(Feature feature)
Description copied from interface:FeatureCollection
Adds a feature to this collection.- Specified by:
add
in interfaceFeatureCollection
- Parameters:
feature
- a Feature to add to the end of this collection
-
addAll
public void addAll(Collection features)
Description copied from interface:FeatureCollection
Adds multiple features to this collection. To be preferred over #add for adding multiple features, because in some systems (like the JUMP Workbench) fewer events will be fired.- Specified by:
addAll
in interfaceFeatureCollection
-
clear
public void clear()
Description copied from interface:FeatureCollection
Removes all features from this collection.- Specified by:
clear
in interfaceFeatureCollection
-
getEnvelope
public org.locationtech.jts.geom.Envelope getEnvelope()
Description copied from interface:FeatureCollection
Returns the bounds of this collection.- Specified by:
getEnvelope
in interfaceFeatureCollection
- Returns:
- the smallest Envelope enclosing all the Features in this collection
-
getFeatures
public List getFeatures()
Description copied from interface:FeatureCollection
Returns an unmodifiable List of the features in this collection- Specified by:
getFeatures
in interfaceFeatureCollection
- Returns:
- a read-only view of all the features
-
getFeatureSchema
public FeatureSchema getFeatureSchema()
Description copied from interface:FeatureCollection
Returns information about this FeatureCollection- Specified by:
getFeatureSchema
in interfaceFeatureCollection
- Returns:
- the types of the attributes of the features in this collection
-
isEmpty
public boolean isEmpty()
Description copied from interface:FeatureCollection
Returns whether this collection has no features.- Specified by:
isEmpty
in interfaceFeatureCollection
- Returns:
- whether or not the size of this collection is 0
-
iterator
public Iterator iterator()
Description copied from interface:FeatureCollection
Returns an Iterator over the features- Specified by:
iterator
in interfaceFeatureCollection
- Returns:
- an Iterator over the features
-
query
public List query(org.locationtech.jts.geom.Envelope envelope)
Description copied from interface:FeatureCollection
A quick search for features, using an envelope comparison.- Specified by:
query
in interfaceFeatureCollection
- Parameters:
envelope
- the envelope to query against- Returns:
- features whose envelopes intersect the given envelope
-
remove
public Collection remove(org.locationtech.jts.geom.Envelope env)
Description copied from interface:FeatureCollection
Removes the features which intersect the given envelope- Specified by:
remove
in interfaceFeatureCollection
- Returns:
- the removed features
-
remove
public void remove(Feature feature)
Description copied from interface:FeatureCollection
Removes a feature from this collection.- Specified by:
remove
in interfaceFeatureCollection
- Parameters:
feature
- a Feature to remove from this collection
-
removeAll
public void removeAll(Collection features)
Description copied from interface:FeatureCollection
Removes multiple features from this collection. To be preferred over #remove for removing multiple features, because in some systems (like the JUMP Workbench) fewer events will be fired.- Specified by:
removeAll
in interfaceFeatureCollection
-
size
public int size()
Description copied from interface:FeatureCollection
Returns the number of features in this collection.- Specified by:
size
in interfaceFeatureCollection
- Returns:
- the number of features in this collection
-
toArray
public Feature[] toArray()
-
finalize
protected void finalize() throws Throwable
-
getWrappee
public FeatureCollection getWrappee()
the PirolFeatureCollection is a wrapper for other feature collections in some cases one might want to work with the original FC. Therefor you can use this method.- Returns:
- the feature collection wrapped by this PirolFeatureCollection
-
-