Package com.luciad.format.gml32.model

Class TLcdGML32UnitDefinition

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.format.gml32.model.TLcdGML32AbstractGML

com.luciad.format.gml32.model.TLcdGML32DefinitionBase

com.luciad.format.gml32.model.TLcdGML32Definition

com.luciad.format.gml32.model.TLcdGML32UnitDefinition

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

Direct Known Subclasses:

TLcdGML32BaseUnit, TLcdGML32ConventionalUnit, TLcdGML32DerivedUnit, TLcdISO19115UnitDefinition, TLcdISO19115UomAlternativeExpression

public class TLcdGML32UnitDefinition
extends TLcdGML32Definition

A gml:UnitDefinition is a general definition of a unit of measure. This generic element is used only for units for which no relationship with other units or units systems is known. The content model of gml:UnitDefinition adds three additional properties to gml:Definition, gml:quantityType, gml:quantityTypeReference and gml:catalogSymbol. The gml:catalogSymbol property optionally gives the short symbol used for this unit. This element is usually used when the relationship of this unit to other units or units systems is unknown.

Since:

10.0

Field Summary

Fields

Modifier and Type	Field	Description
static final TLcdDataProperty	CATALOG_SYMBOL_PROPERTY	Data property that maps to the catalogSymbol element.
static final TLcdDataProperty	QUANTITY_TYPE_PROPERTY	Data property that maps to the quantityType element.
static final TLcdDataProperty	QUANTITY_TYPE_REFERENCE_PROPERTY	Data property that maps to the quantityTypeReference element.

Fields inherited from class com.luciad.format.gml32.model.TLcdGML32Definition

REMARKS_PROPERTY

Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML

DESCRIPTION_PROPERTY, DESCRIPTION_REFERENCE_PROPERTY, ID_PROPERTY, IDENTIFIER_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdGML32UnitDefinition()
TLcdGML32UnitDefinition(TLcdDataType aType)

Method Summary

Modifier and Type	Method	Description
TLcdGML32Code	getCatalogSymbol()	Returns the value of the property that maps to the catalogSymbol element.
TLcdGML32StringOrRef	getQuantityType()	Returns the value of the property that maps to the quantityType element.
TLcdGML32Reference	getQuantityTypeReference()	Returns the value of the property that maps to the quantityTypeReference element.
void	setCatalogSymbol(TLcdGML32Code aValue)	Sets the value of the property that maps to the catalogSymbol element.
void	setQuantityType(TLcdGML32StringOrRef aValue)	Sets the value of the property that maps to the quantityType element.
void	setQuantityTypeReference(TLcdGML32Reference aValue)	Sets the value of the property that maps to the quantityTypeReference element.

Methods inherited from class com.luciad.format.gml32.model.TLcdGML32Definition

getRemarks, setRemarks

Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML

getDescription, getDescriptionReference, getId, getIdentifier, getMetaDataProperty, getName, setDescription, setDescriptionReference, setId, setIdentifier

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object

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

Field Details

QUANTITY_TYPE_PROPERTY

public static final TLcdDataProperty QUANTITY_TYPE_PROPERTY

Data property that maps to the quantityType element. The possible values for this property are instances of TLcdGML32StringOrRef.

QUANTITY_TYPE_REFERENCE_PROPERTY

public static final TLcdDataProperty QUANTITY_TYPE_REFERENCE_PROPERTY

Data property that maps to the quantityTypeReference element. The possible values for this property are instances of TLcdGML32Reference.

CATALOG_SYMBOL_PROPERTY

public static final TLcdDataProperty CATALOG_SYMBOL_PROPERTY

Data property that maps to the catalogSymbol element. The possible values for this property are instances of TLcdGML32Code.

Constructor Details

TLcdGML32UnitDefinition

public TLcdGML32UnitDefinition()

TLcdGML32UnitDefinition

public TLcdGML32UnitDefinition(TLcdDataType aType)

Method Details

getQuantityType

public TLcdGML32StringOrRef getQuantityType()

Returns the value of the property that maps to the quantityType element.

The gml:quantityType property indicates the phenomenon to which the units apply. This element contains an informal description of the phenomenon or type of physical quantity that is measured or observed. When the physical quantity is the result of an observation or measurement, this term is known as observable type or measurand. The use of gml:quantityType for references to remote values is deprecated.

Returns:

the value of the QUANTITY_TYPE_PROPERTY property.

setQuantityType

public void setQuantityType(TLcdGML32StringOrRef aValue)

Sets the value of the property that maps to the quantityType element.

The gml:quantityType property indicates the phenomenon to which the units apply. This element contains an informal description of the phenomenon or type of physical quantity that is measured or observed. When the physical quantity is the result of an observation or measurement, this term is known as observable type or measurand. The use of gml:quantityType for references to remote values is deprecated.

Parameters:

aValue - the value to set for the QUANTITY_TYPE_PROPERTY property.

getQuantityTypeReference

public TLcdGML32Reference getQuantityTypeReference()

Returns the value of the property that maps to the quantityTypeReference element.

The gml:quantityTypeReference property indicates the phenomenon to which the units apply. The content is a reference to a remote value.

Returns:

the value of the QUANTITY_TYPE_REFERENCE_PROPERTY property.

setQuantityTypeReference

public void setQuantityTypeReference(TLcdGML32Reference aValue)

Sets the value of the property that maps to the quantityTypeReference element.

The gml:quantityTypeReference property indicates the phenomenon to which the units apply. The content is a reference to a remote value.

Parameters:

aValue - the value to set for the QUANTITY_TYPE_REFERENCE_PROPERTY property.

getCatalogSymbol

public TLcdGML32Code getCatalogSymbol()

Returns the value of the property that maps to the catalogSymbol element.

The catalogSymbol is the preferred lexical symbol used for this unit of measure. The codeSpace attribute in gml:CodeType identifies a namespace for the catalog symbol value, and might reference the external catalog. The string value in gml:CodeType contains the value of a symbol that should be unique within this catalog namespace. This symbol often appears explicitly in the catalog, but it could be a combination of symbols using a specified algebra of units.

Returns:

the value of the CATALOG_SYMBOL_PROPERTY property.

setCatalogSymbol

public void setCatalogSymbol(TLcdGML32Code aValue)

Sets the value of the property that maps to the catalogSymbol element.

The catalogSymbol is the preferred lexical symbol used for this unit of measure. The codeSpace attribute in gml:CodeType identifies a namespace for the catalog symbol value, and might reference the external catalog. The string value in gml:CodeType contains the value of a symbol that should be unique within this catalog namespace. This symbol often appears explicitly in the catalog, but it could be a combination of symbols using a specified algebra of units.

Parameters:

aValue - the value to set for the CATALOG_SYMBOL_PROPERTY property.