FeatureRef (SWE Common OM and GML Models 1.1-beta1 API)

java.lang.Object
- org.vast.ogc.xlink.CachedReference<GenericFeature>
- - org.vast.ogc.gml.FeatureRef

All Implemented Interfaces:

AbstractFeature, AbstractGML, GenericFeature, IXlinkReference<GenericFeature>

Direct Known Subclasses:

ObservationRef, ProcedureRef
```
public class FeatureRef
extends CachedReference<GenericFeature>
implements GenericFeature
```
Wrapper class for use when an IFeature object is or can be included by reference. This enables fetching and instantiating the target object lazily.

Since:

Sep 28, 2012

Author:

Alex Robin

Constructor Summary

Constructors
Constructor and Description

FeatureRef()

FeatureRef(String href)

Constructors
Constructor and Description
`FeatureRef()`
`FeatureRef(String href)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addName(Code name)` Adds a new name property
`Envelope`	`getBoundedBy()` Gets the boundedBy property
`String`	`getDescription()` Gets the description property
`Reference`	`getDescriptionReference()` Gets the descriptionReference property
`String`	`getId()` Gets the id property
`CodeWithAuthority`	`getIdentifier()` Gets the identifier property
`AbstractGeometry`	`getLocation()` Gets the location property
`OgcProperty<AbstractGeometry>`	`getLocationProperty()` Gets extra info (name, xlink, etc.) carried by the location property
`OgcPropertyList<Object>`	`getMetaDataPropertyList()` Gets the list of metaDataProperty properties
`String`	`getName()`
`List<Code>`	`getNameList()` Gets the list of name properties
`int`	`getNumNames()` Returns number of name properties
`Map<QName,Object>`	`getProperties()`
`Object`	`getProperty(QName qname)`
`Object`	`getProperty(String name)`
`QName`	`getQName()`
`String`	`getType()`
`String`	`getUniqueIdentifier()` Gets the identifier property
`boolean`	`isSetBoundedBy()` Checks if boundedBy is set
`boolean`	`isSetDescription()` Checks if description is set
`boolean`	`isSetDescriptionReference()` Checks if descriptionReference is set
`boolean`	`isSetIdentifier()` Checks if identifier is set
`boolean`	`isSetLocation()` Checks if location is set
`void`	`setBoundedByAsEnvelope(Envelope boundedBy)` Sets the boundedByAsEnvelope property
`void`	`setDescription(String description)` Sets the description property
`void`	`setDescriptionReference(Reference descriptionReference)` Sets the descriptionReference property
`void`	`setId(String id)` Sets the id property
`void`	`setIdentifier(CodeWithAuthority identifier)` Sets the identifier property
`void`	`setLocation(AbstractGeometry location)` Sets the locationAsAbstractGeometry property
`void`	`setName(String name)` Sets the default name
`void`	`setProperty(QName qname, Object value)`
`void`	`setProperty(String name, Object value)`
`void`	`setType(String type)`
`void`	`setUniqueIdentifier(String identifier)` Sets the identifier property

Methods inherited from class org.vast.ogc.xlink.CachedReference
getArcRole, getHref, getRole, getTarget, refresh, setArcRole, setHref, setResolver, setRole

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FeatureRef
```
public FeatureRef()
```
  - FeatureRef
```
public FeatureRef(String href)
```
- Method Detail
  - getMetaDataPropertyList
```
public OgcPropertyList<Object> getMetaDataPropertyList()
```
    Description copied from interface: AbstractGML
    
    Gets the list of metaDataProperty properties
    
    Specified by:
    
    getMetaDataPropertyList in interface AbstractGML
  - getBoundedBy
```
public Envelope getBoundedBy()
```
    Description copied from interface: AbstractFeature
    
    Gets the boundedBy property
    
    Specified by:
    
    getBoundedBy in interface AbstractFeature
  - isSetBoundedBy
```
public boolean isSetBoundedBy()
```
    Description copied from interface: AbstractFeature
    
    Checks if boundedBy is set
    
    Specified by:
    
    isSetBoundedBy in interface AbstractFeature
  - getDescription
```
public String getDescription()
```
    Description copied from interface: AbstractGML
    
    Gets the description property
    
    Specified by:
    
    getDescription in interface AbstractGML
  - setBoundedByAsEnvelope
```
public void setBoundedByAsEnvelope(Envelope boundedBy)
```
    Description copied from interface: AbstractFeature
    
    Sets the boundedByAsEnvelope property
    
    Specified by:
    
    setBoundedByAsEnvelope in interface AbstractFeature
  - isSetDescription
```
public boolean isSetDescription()
```
    Description copied from interface: AbstractGML
    
    Checks if description is set
    
    Specified by:
    
    isSetDescription in interface AbstractGML
  - getLocation
```
public AbstractGeometry getLocation()
```
    Description copied from interface: AbstractFeature
    
    Gets the location property
    
    Specified by:
    
    getLocation in interface AbstractFeature
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: AbstractGML
    
    Sets the description property
    
    Specified by:
    
    setDescription in interface AbstractGML
  - getQName
```
public QName getQName()
```
    Specified by:
    
    getQName in interface AbstractFeature
    
    Specified by:
    
    getQName in interface GenericFeature
    
    Returns:
    Qualified name of feature type
  - getLocationProperty
```
public OgcProperty<AbstractGeometry> getLocationProperty()
```
    Description copied from interface: AbstractFeature
    
    Gets extra info (name, xlink, etc.) carried by the location property
    
    Specified by:
    
    getLocationProperty in interface AbstractFeature
  - getDescriptionReference
```
public Reference getDescriptionReference()
```
    Description copied from interface: AbstractGML
    
    Gets the descriptionReference property
    
    Specified by:
    
    getDescriptionReference in interface AbstractGML
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface GenericFeature
  - setType
```
public void setType(String type)
```
    Specified by:
    
    setType in interface GenericFeature
  - getProperties
```
public Map<QName,Object> getProperties()
```
    Specified by:
    
    getProperties in interface GenericFeature
  - isSetDescriptionReference
```
public boolean isSetDescriptionReference()
```
    Description copied from interface: AbstractGML
    
    Checks if descriptionReference is set
    
    Specified by:
    
    isSetDescriptionReference in interface AbstractGML
  - getProperty
```
public Object getProperty(String name)
```
    Specified by:
    
    getProperty in interface GenericFeature
  - isSetLocation
```
public boolean isSetLocation()
```
    Description copied from interface: AbstractFeature
    
    Checks if location is set
    
    Specified by:
    
    isSetLocation in interface AbstractFeature
  - setProperty
```
public void setProperty(String name,
               Object value)
```
    Specified by:
    
    setProperty in interface GenericFeature
  - getProperty
```
public Object getProperty(QName qname)
```
    Specified by:
    
    getProperty in interface GenericFeature
  - setLocation
```
public void setLocation(AbstractGeometry location)
```
    Description copied from interface: AbstractFeature
    
    Sets the locationAsAbstractGeometry property
    
    Specified by:
    
    setLocation in interface AbstractFeature
  - setDescriptionReference
```
public void setDescriptionReference(Reference descriptionReference)
```
    Description copied from interface: AbstractGML
    
    Sets the descriptionReference property
    
    Specified by:
    
    setDescriptionReference in interface AbstractGML
  - setProperty
```
public void setProperty(QName qname,
               Object value)
```
    Specified by:
    
    setProperty in interface GenericFeature
  - getIdentifier
```
public CodeWithAuthority getIdentifier()
```
    Description copied from interface: AbstractGML
    
    Gets the identifier property
    
    Specified by:
    
    getIdentifier in interface AbstractGML
  - getUniqueIdentifier
```
public String getUniqueIdentifier()
```
    Description copied from interface: AbstractGML
    
    Gets the identifier property
    
    Specified by:
    
    getUniqueIdentifier in interface AbstractGML
  - isSetIdentifier
```
public boolean isSetIdentifier()
```
    Description copied from interface: AbstractGML
    
    Checks if identifier is set
    
    Specified by:
    
    isSetIdentifier in interface AbstractGML
  - setIdentifier
```
public void setIdentifier(CodeWithAuthority identifier)
```
    Description copied from interface: AbstractGML
    
    Sets the identifier property
    
    Specified by:
    
    setIdentifier in interface AbstractGML
  - setUniqueIdentifier
```
public void setUniqueIdentifier(String identifier)
```
    Description copied from interface: AbstractGML
    
    Sets the identifier property
    
    Specified by:
    
    setUniqueIdentifier in interface AbstractGML
  - getNameList
```
public List<Code> getNameList()
```
    Description copied from interface: AbstractGML
    
    Gets the list of name properties
    
    Specified by:
    
    getNameList in interface AbstractGML
  - getNumNames
```
public int getNumNames()
```
    Description copied from interface: AbstractGML
    
    Returns number of name properties
    
    Specified by:
    
    getNumNames in interface AbstractGML
  - addName
```
public void addName(Code name)
```
    Description copied from interface: AbstractGML
    
    Adds a new name property
    
    Specified by:
    
    addName in interface AbstractGML
  - setName
```
public void setName(String name)
```
    Description copied from interface: AbstractGML
    
    Sets the default name
    
    Specified by:
    
    setName in interface AbstractGML
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface AbstractGML
    
    Returns:
    the default name
  - getId
```
public String getId()
```
    Description copied from interface: AbstractGML
    
    Gets the id property
    
    Specified by:
    
    getId in interface AbstractGML
  - setId
```
public void setId(String id)
```
    Description copied from interface: AbstractGML
    
    Sets the id property
    
    Specified by:
    
    setId in interface AbstractGML

Class FeatureRef

Constructor Summary

Method Summary

Methods inherited from class org.vast.ogc.xlink.CachedReference

Methods inherited from class java.lang.Object

Constructor Detail

FeatureRef

FeatureRef

Method Detail

getMetaDataPropertyList

getBoundedBy

isSetBoundedBy

getDescription

setBoundedByAsEnvelope

isSetDescription

getLocation

setDescription

getQName

getLocationProperty

getDescriptionReference

getType

setType

getProperties

isSetDescriptionReference

getProperty

isSetLocation

setProperty

getProperty

setLocation

setDescriptionReference

setProperty

getIdentifier

getUniqueIdentifier

isSetIdentifier

setIdentifier

setUniqueIdentifier

getNameList

getNumNames

addName

setName

getName

getId

setId