org.geotools.feature
Class FeatureImpl

java.lang.Object
  org.geotools.feature.FeatureImpl

All Implemented Interfaces:

Feature

public class FeatureImpl

extends java.lang.Object

implements Feature

This is a sample implementation of the FeatureType API.

The suffix implementation is used to indicat this is a direct, straight forward implementation of the associated interface.

This serves as, my reference implementation, if you have any questions please contact me (jgarnett@refractions.net) or jump on the geotools-devel email list. There is a good chance my understanding is wrong, I expect and want feedback on this implementation.

I especially am interested in:

• XPATH - xpath is used to locate AttributeTyp instances. Does this even work? FeatureType captures schema information, you cannot do an xpath query based on

  Author:

  Jody Garnett, Refractions Research

  Nested Class Summary

  Nested classes inherited from class org.geotools.feature.Feature

  Feature.NULL

  Constructor Summary

  FeatureImpl()
  

  Method Summary

  java.lang.Object	getAttribute(int index) Gets an attribute by the given zero-based index.
  java.lang.Object	getAttribute(java.lang.String xPath) Gets an attribute for this feature at the location specified by xPath.
  java.lang.Object[]	getAttributes(java.lang.Object[] attributes) Copy all the attributes of this Feature into the given array.
  com.vividsolutions.jts.geom.Envelope	getBounds() Get the total bounds of this feature which is calculated by doing a union of the bounds of each geometry this feature is associated with.
  com.vividsolutions.jts.geom.Geometry	getDefaultGeometry() Gets the default geometry for this feature.
  FeatureType	getFeatureType() Gets a reference to the schema for this feature.
  java.lang.String	getID() Gets the unique feature ID for this feature.
  int	getNumberOfAttributes() Get the number of attributes this feature has.
  FeatureCollection	getParent() Gets the feature collection this feature is stored in.
  void	setAttribute(int position, java.lang.Object val) Sets an attribute by the given zero-based index.
  void	setAttribute(java.lang.String xPath, java.lang.Object attribute) Sets a single attribute for this feature, passed as a complex object.
  void	setDefaultGeometry(com.vividsolutions.jts.geom.Geometry geometry) Sets the default geometry for this feature.
  void	setParent(FeatureCollection collection) Sets the parent collection this feature is stored in, if it is not already set.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Constructor Detail

  FeatureImpl

  public FeatureImpl()

  Method Detail

  getParent

  public FeatureCollection getParent()

  Description copied from interface: Feature

  Gets the feature collection this feature is stored in.

  Specified by:

  getParent in interface Feature

  Returns:

  The collection that is the parent of this feature.

  setParent

  public void setParent(FeatureCollection collection)

  Description copied from interface: Feature

  Sets the parent collection this feature is stored in, if it is not already set. If it is set then this method does nothing.

  Specified by:

  setParent in interface Feature

  Parameters:

  collection - the collection to be set as parent.

  getFeatureType

  public FeatureType getFeatureType()

  Description copied from interface: Feature

  Gets a reference to the schema for this feature.

  Specified by:

  getFeatureType in interface Feature

  Returns:

  A reference to this feature's schema.

  getID

  public java.lang.String getID()

  Description copied from interface: Feature

  Gets the unique feature ID for this feature.

  Specified by:

  getID in interface Feature

  Returns:

  Unique identifier for this feature.

  getAttributes

  public java.lang.Object[] getAttributes(java.lang.Object[] attributes)

  Description copied from interface: Feature

  Copy all the attributes of this Feature into the given array. If the argument array is null, a new one will be created. Gets all attributes from this feature, returned as a complex object array. This array comes with no metadata, so to interpret this collection the caller class should ask for the schema as well. This array may have multiple entries for each AttributeType depending on the AttributeType's multiplicity.

  Specified by:

  getAttributes in interface Feature

  Parameters:

  attributes - An array to copy attributes into. May be null.

  Returns:

  The array passed in, or a new one if null.

  getAttribute

  public java.lang.Object getAttribute(java.lang.String xPath)

  Description copied from interface: Feature

  Gets an attribute for this feature at the location specified by xPath. Due to the complex nature of xpath, a List of all valid values will be returned when an attribute is requested. These values can range from complete Feature Collections to single primative attribute values. When a particular instance of the Attribute is requested, then the Object will be returned. Simply put, in the general case we are assuming the existance of multiplicity, so specify which instance you want or you get them all. Example of getting a list: ./road returns the List of road attribute instances Example of getting an Object: ./road[0] returns the first road

  Specified by:

  getAttribute in interface Feature

  Parameters:

  xPath - XPath representation of attribute location.

  Returns:

  A List of copies of the requested attribute, null if the requested xpath is not found, or NULL_ATTRIBUTE.

  getAttribute

  public java.lang.Object getAttribute(int index)

  Description copied from interface: Feature

  Gets an attribute by the given zero-based index. This index is based on the values within the Feature as opposed to the AttributeType declaration. To get the values for the 5th attributeType, use the schema to determine the xPath and class the getAttribute(xPath) method.

  Specified by:

  getAttribute in interface Feature

  Parameters:

  index - The requested index. Must be 0 <= idx < getNumberOfAttributes().

  Returns:

  A copy of the requested attribute, or NULL_ATTRIBUTE.

  See Also:

  Feature.getAttribute(String)

  setAttribute

  public void setAttribute(int position,
                           java.lang.Object val)
                    throws IllegalAttributeException,
                           java.lang.ArrayIndexOutOfBoundsException

  Description copied from interface: Feature

  Sets an attribute by the given zero-based index. This index is based on the values within the Feature as opposed to the AttributeType declaration. To get the values for the 5th attributeType, use the schema to determine the xPath and class the setAttribute(xPath,val) method.

  Specified by:

  setAttribute in interface Feature

  Parameters:

  position - The requested index. Must be 0 <= idx < getNumberOfAttributes()

  val - An object representing the attribute being set

  Throws:

  java.lang.ArrayIndexOutOfBoundsException - if an invalid position is given

  IllegalAttributeException - if the passed in val does not validate against the AttributeType at that position.

  See Also:

  Feature.setAttribute(String, Object)

  getNumberOfAttributes

  public int getNumberOfAttributes()

  Description copied from interface: Feature

  Get the number of attributes this feature has. This is NOT simply a convenience method for calling getFeatureType().getNumberOfAttributes(). This is the same as calling getAttributes(null).length. This represents the number of actual attribute values in the feature, and may differ from the number of AttributeTypes defined in the FeatureType based on the multiplicity of the AttributeTypes.

  Specified by:

  getNumberOfAttributes in interface Feature

  Returns:

  The total number of attributes this Feature contains.

  setAttribute

  public void setAttribute(java.lang.String xPath,
                           java.lang.Object attribute)
                    throws IllegalAttributeException

  Description copied from interface: Feature

  Sets a single attribute for this feature, passed as a complex object. If the attribute does not exist or the object does not conform to the internal schema, an exception is thrown. Checking this is, of course, left to the feature to do internally. Well behaved features should always fully check the passed attributes against thire schema before adding them. NOTE: The xPath may contain instance information about multiplicity, for example: ./road[3] which is the third road attribute in this feature.

  Specified by:

  setAttribute in interface Feature

  Parameters:

  xPath - XPath representation of attribute location.

  attribute - Feature attribute to set.

  Throws:

  IllegalAttributeException - If the attribute is illegal for the path specified.

  getDefaultGeometry

  public com.vividsolutions.jts.geom.Geometry getDefaultGeometry()

  Description copied from interface: Feature

  Gets the default geometry for this feature.

  This method will return null if no DefaultGeometry has been defined by the schema.

  Specified by:

  getDefaultGeometry in interface Feature

  Returns:

  Default geometry for this feature, or null

  setDefaultGeometry

  public void setDefaultGeometry(com.vividsolutions.jts.geom.Geometry geometry)
                          throws IllegalAttributeException

  Description copied from interface: Feature

  Sets the default geometry for this feature.

  Specified by:

  setDefaultGeometry in interface Feature

  Parameters:

  geometry - The geometry to set.

  Throws:

  IllegalAttributeException - If the AttributeType is not a geometry, or is invalid for some other reason.

  getBounds

  public com.vividsolutions.jts.geom.Envelope getBounds()

  Description copied from interface: Feature

  Get the total bounds of this feature which is calculated by doing a union of the bounds of each geometry this feature is associated with.

  This method will return an empty Envelope if the feature contains no geometry information.

  Specified by:

  getBounds in interface Feature

  Returns:

  An Envelope containing the total bounds of this Feature.