deegree-core-3.0-pre-nightly (2010/03/05 00:01) - official

org.deegree.feature
Class GenericFeature

java.lang.Object
  extended by org.deegree.feature.AbstractFeature
      extended by org.deegree.feature.GenericFeature
All Implemented Interfaces:
Feature, MatchableObject, GMLObject

public class GenericFeature
extends AbstractFeature

Allows the representation of arbitrary Features.

Please note that it may be more efficient to use the GenericSimpleFeature class if the feature to be represented does not contain multiple properties or nested features ("complex properties").

Version:
$Revision:$, $Date:$
Author:
Markus Schneider , last edited by: $Author:$
See Also:
GenericSimpleFeature

Field Summary
 
Fields inherited from class org.deegree.feature.AbstractFeature
standardProps
 
Constructor Summary
GenericFeature(GenericFeatureType ft, String fid, List<Property<?>> props, GMLVersion version)
          Creates a new GenericFeature instance.
 
Method Summary
 Property<Geometry>[] getGeometryProperties()
          Returns all geometry-valued properties in order.
 String getId()
          Returns the id of the feature.
 QName getName()
          Returns the name of the feature.
 Property<?>[] getProperties()
          Returns all properties in order, excluding standard GML properties such as gml:name.
 Property<?>[] getProperties(QName propName)
          Returns the properties with the given name, in order.
 Property<?> getProperty(QName propName)
          Returns the property with the given name.
 Object getPropertyValue(QName propName)
          Returns the values of the property with the given name.
 Object[] getPropertyValues(QName propName)
          Returns the values of the properties with the given name, in order.
 FeatureType getType()
          Returns the type information for this feature.
 void setId(String fid)
          Sets the id of the feature.
 void setProperties(List<Property<?>> props)
          Called during construction to initialize the properties of the feature.
 void setPropertyValue(QName propName, int occurrence, Object value)
          Sets the value of a specific occurence of a property with a given name (or removes the property feature).
 
Methods inherited from class org.deegree.feature.AbstractFeature
calcEnvelope, getEnvelope, getGMLProperties, getProperties, getProperties, getProperty, getPropertyValue, getPropertyValues, getPropertyValues, setProperties, setPropertyValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GenericFeature

public GenericFeature(GenericFeatureType ft,
                      String fid,
                      List<Property<?>> props,
                      GMLVersion version)
Creates a new GenericFeature instance.

Parameters:
ft - feature type, must not be null
fid - feature id or null if the feature is anonymous (discouraged for most use cases)
props - properties of the feature
version - GML version (determines the names/types of the standard properties), or null (then no standard GML properties are allowed)
Method Detail

getId

public String getId()
Description copied from interface: Feature
Returns the id of the feature.

In an GML representation of the feature, this corresponds to the gml:id (GML 3 and later) or fid (GML 2) attribute of the feature element.

Returns:
the id of the feature

setId

public void setId(String fid)
Description copied from interface: Feature
Sets the id of the feature.

In an GML representation of the feature, this corresponds to the gml:id (GML 3 and later) or fid (GML 2) attribute of the feature element.

Parameters:
fid - the id of the feature instance

getName

public QName getName()
Description copied from interface: Feature
Returns the name of the feature.

In an GML representation of the feature, this corresponds to the feature element's name.

Returns:
the name of the feature instance

getType

public FeatureType getType()
Description copied from interface: Feature
Returns the type information for this feature.

Returns:
the type information

getProperties

public Property<?>[] getProperties()
Description copied from interface: Feature
Returns all properties in order, excluding standard GML properties such as gml:name.

Returns:
all properties, excluding standard GML properties

setProperties

public void setProperties(List<Property<?>> props)
                   throws IllegalArgumentException
Description copied from interface: Feature
Called during construction to initialize the properties of the feature.

Throws:
IllegalArgumentException - if the property names or values are not compatible with the feature type

setPropertyValue

public void setPropertyValue(QName propName,
                             int occurrence,
                             Object value)
Description copied from interface: Feature
Sets the value of a specific occurence of a property with a given name (or removes the property feature).

Parameters:
propName - property name
occurrence - index of the property, starting with zero. If the property is not a multi-property (i.e. maxOccurs=1), this is always zero.
value - new value of the property or null (removes the property)

getProperties

public Property<?>[] getProperties(QName propName)
Description copied from interface: Feature
Returns the properties with the given name, in order.

Parameters:
propName - name of the requested properties
Returns:
the properties with the given name, in order

getProperty

public Property<?> getProperty(QName propName)
Description copied from interface: Feature
Returns the property with the given name.

Parameters:
propName - name of the requested property
Returns:
the property with the given name

getPropertyValue

public Object getPropertyValue(QName propName)
Description copied from interface: Feature
Returns the values of the property with the given name.

Parameters:
propName - name of the requested property
Returns:
the values of the properties with the given name

getPropertyValues

public Object[] getPropertyValues(QName propName)
Description copied from interface: Feature
Returns the values of the properties with the given name, in order.

Parameters:
propName - name of the requested property
Returns:
the values of the properties with the given name, in order

getGeometryProperties

public Property<Geometry>[] getGeometryProperties()
Description copied from interface: Feature
Returns all geometry-valued properties in order.

Returns:
all geometry properties

deegree-core-3.0-pre-nightly (2010/03/05 00:01) - official

an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://www.deegree.org

]]>