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

org.deegree.gml.feature
Class StandardGMLFeatureProps

java.lang.Object
  extended by org.deegree.gml.props.GMLStdProps
      extended by org.deegree.gml.feature.StandardGMLFeatureProps

public class StandardGMLFeatureProps
extends GMLStdProps

Version-agnostic representation of the standard properties that any GML Feature allows for.

Version:
$Revision: 21974 $, $Date: 2010-01-15 19:06:57 +0100 (Fr, 15 Jan 2010) $
Author:
Markus Schneider, last edited by: $Author: mschneider $
See Also:
GMLStdProps

Field Summary
static PropertyType<Envelope> PT_BOUNDED_BY_GML2
          GML 2 standard property type 'gml:boundedBy'
static PropertyType<Envelope> PT_BOUNDED_BY_GML31
          GML 3.0/3.1 standard property type 'gml:boundedBy'
static PropertyType<Envelope> PT_BOUNDED_BY_GML32
          GML 3.2 standard property type 'gml:boundedBy'
 
Fields inherited from class org.deegree.gml.props.GMLStdProps
description, identifier, metadata, names, PT_DESCRIPTION_GML2, PT_DESCRIPTION_GML31, PT_DESCRIPTION_GML32, PT_DESCRIPTION_REFERENCE_GML32, PT_IDENTIFIER_GML32, PT_META_DATA_PROPERTY_GML31, PT_META_DATA_PROPERTY_GML32, PT_NAME_GML2, PT_NAME_GML31, PT_NAME_GML32
 
Constructor Summary
StandardGMLFeatureProps(Object[] metadata, StringOrRef description, CodeType identifier, CodeType[] names, Envelope boundedBy)
          Creates a new StandardGMLFeatureProps instance.
 
Method Summary
static Pair<StandardGMLFeatureProps,List<Property<?>>> create(List<Property<?>> props, GMLVersion version)
          Creates a StandardGMLFeatureProps instances from the given list of Property objects and returns the remaining properties that are not GML default properties.
 Envelope getBoundedBy()
          Returns the boundedBy property value.
 Collection<Property<?>> getProperties(GMLVersion version)
          Returns the corresponding Property instances for a specific GML version.
 Property<?>[] getProperties(QName propName, GMLVersion version)
          Returns the standard GML properties with the given name.
 Object[] getPropertiesValues(QName propName, GMLVersion version)
          Returns the values of the standard GML properties with the given name.
 Property<?> getProperty(QName propName, GMLVersion version)
          Returns the standard GML property with the given name.
static PropertyType<?> getPropertyType(QName propName, GMLVersion version)
          Returns the standard GML property declaration with the given name for the specified GML version.
static Collection<PropertyType<?>> getPropertyTypes(GMLVersion version)
          Returns the declaration for standard properties that any GML feature allows for.
 Object getPropertyValue(QName propName, GMLVersion version)
          Returns the value of the standard GML property with the given name.
 void setBoundedBy(Envelope boundedBy)
          Sets the value for the boundedBy property.
 boolean setPropertyValue(QName propName, int occurence, Object value, GMLVersion version)
           
 String toString()
           
 
Methods inherited from class org.deegree.gml.props.GMLStdProps
getDescription, getIdentifier, getMetadata, getNames
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PT_BOUNDED_BY_GML2

public static final PropertyType<Envelope> PT_BOUNDED_BY_GML2
GML 2 standard property type 'gml:boundedBy'


PT_BOUNDED_BY_GML31

public static final PropertyType<Envelope> PT_BOUNDED_BY_GML31
GML 3.0/3.1 standard property type 'gml:boundedBy'


PT_BOUNDED_BY_GML32

public static final PropertyType<Envelope> PT_BOUNDED_BY_GML32
GML 3.2 standard property type 'gml:boundedBy'

Constructor Detail

StandardGMLFeatureProps

public StandardGMLFeatureProps(Object[] metadata,
                               StringOrRef description,
                               CodeType identifier,
                               CodeType[] names,
                               Envelope boundedBy)
Creates a new StandardGMLFeatureProps instance.

Parameters:
metadata - metadata values, may be null
description - description, may be null
identifier - identifier, may be null
names - names, may be null
boundedBy - bounding box, may be null
Method Detail

getBoundedBy

public Envelope getBoundedBy()
Returns the boundedBy property value.

Returns:
boundedBy property value, or null if not defined

setBoundedBy

public void setBoundedBy(Envelope boundedBy)
Sets the value for the boundedBy property.

Parameters:
boundedBy - the value for the boundedBy property (or null to clear it)

getProperties

public Collection<Property<?>> getProperties(GMLVersion version)
Returns the corresponding Property instances for a specific GML version.

Parameters:
version - GML version, must not be null
Returns:
corresponding Property instances, may be empty, but never null

getProperty

public Property<?> getProperty(QName propName,
                               GMLVersion version)
Returns the standard GML property with the given name.

Parameters:
propName - name of the requested property, must not be null
version - GML version, must not be null
Returns:
corresponding Property instance or null if no such property exists

getPropertyValue

public Object getPropertyValue(QName propName,
                               GMLVersion version)
Returns the value of the standard GML property with the given name.

Parameters:
propName - name of the requested property, must not be null
version - GML version, must not be null
Returns:
corresponding value or null if no such property exists

getProperties

public Property<?>[] getProperties(QName propName,
                                   GMLVersion version)
Returns the standard GML properties with the given name.

Parameters:
propName - name of the requested properties, must not be null
version - GML version, must not be null
Returns:
corresponding Property instances or null if no such property exists

getPropertiesValues

public Object[] getPropertiesValues(QName propName,
                                    GMLVersion version)
Returns the values of the standard GML properties with the given name.

Parameters:
propName - name of the requested properties, must not be null
version - GML version, must not be null
Returns:
corresponding Property values or null if no such property exists

getPropertyTypes

public static Collection<PropertyType<?>> getPropertyTypes(GMLVersion version)
Returns the declaration for standard properties that any GML feature allows for.

Parameters:
version - GML version, must not be null
Returns:
standard GML property types, in expected order

getPropertyType

public static PropertyType<?> getPropertyType(QName propName,
                                              GMLVersion version)
Returns the standard GML property declaration with the given name for the specified GML version.

Parameters:
propName - qualified name of the property
version - GML version, must not be null
Returns:
standard GML property type, or null if no such property type exists

setPropertyValue

public boolean setPropertyValue(QName propName,
                                int occurence,
                                Object value,
                                GMLVersion version)

create

public static Pair<StandardGMLFeatureProps,List<Property<?>>> create(List<Property<?>> props,
                                                                     GMLVersion version)
Creates a StandardGMLFeatureProps instances from the given list of Property objects and returns the remaining properties that are not GML default properties.

Parameters:
props -
version - GML version, must not be null
Returns:
created instance and remaining (non-default) properties

toString

public String toString()
Overrides:
toString in class GMLStdProps

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

]]>