OmObservation (52°North Shetland 8.2.1 API)

java.lang.Object
- org.n52.shetland.ogc.gml.AbstractGML
- - org.n52.shetland.ogc.gml.AbstractFeature
  - - org.n52.shetland.ogc.om.OmObservation

All Implemented Interfaces:

HasDefaultEncoding<AbstractFeature>

Direct Known Subclasses:

AbstractInspireObservation
```
public class OmObservation
extends AbstractFeature
```
Class represents a SOS/O&M observation

Since:

1.0.0

Constructor Summary

Constructors
Constructor and Description
`OmObservation()` constructor.
`OmObservation(CodeWithAuthority identifier)` constructor.
`OmObservation(CodeWithAuthority identifier, String gmlId)` constructor.
`OmObservation(String identifier)` constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OmObservation`	`addCategoryParameter(NamedValue<String> categoryParameter)`
`OmObservation`	`addCategoryParameter(String category)` Add category to observation
`OmObservation`	`addCategoryParameter(TextValue category)`
`void`	`addParameter(NamedValue<?> namedValue)` Add parameter
`void`	`addRelatedObservation(OmObservationContext relatedObservation)` Add a related observation
`void`	`addRelatedObservations(Set<OmObservationContext> relatedObservations)` Add related observations
`OmObservation`	`addResultQuality(OmResultQuality qualityList)`
`OmObservation`	`addResultQuality(Set<OmResultQuality> qualityList)`
`OmObservation`	`addSpatialFilteringProfileParameter(org.locationtech.jts.geom.Geometry samplingGeometry)` Add sampling geometry to observation
`boolean`	`checkForMerge(OmObservation observation)`
`boolean`	`checkForMerge(OmObservation observation, ObservationMergeIndicator indicator)`
`OmObservation`	`cloneTemplate()`
`OmObservation`	`cloneTemplate(boolean withIdentifierNameDesription)`
`protected OmObservation`	`cloneTemplate(OmObservation clone)`
`TVPValue`	`convertSingleValueToMultiValue(SingleObservationValue<?> singleValue)` Convert `SingleObservationValue` to `TVPValue`.
`OmObservation`	`copyTo(OmObservation copyOf)`
`String`	`getAdditionalMergeIndicator()`
`NamedValue<String>`	`getCategoryParameter()` Get category parameter
`String`	`getDecimalSeparator()` Get decimal separator.
`NamedValue<BigDecimal>`	`getDepthParameter()` Get depth parameter
`String`	`getGmlId()` Get GML id
`NamedValue<BigDecimal>`	`getHeightDepthParameter()`
`NamedValue<BigDecimal>`	`getHeightParameter()` Get height parameter
`String`	`getNoDataValue()` Get noData value.
`OmObservationConstellation`	`getObservationConstellation()` Get the observation constellation.
`String`	`getObservationID()` Get observation ID.
`Collection<NamedValue<?>>`	`getParameter()` Get parameter
`ParameterHolder`	`getParameterHolder()`
`Time`	`getPhenomenonTime()` Get phenomenon time.
`Set<OmObservationContext>`	`getRelatedObservations()` Get related observations
`Set<OmResultQuality>`	`getResultQuality()` Get result quality.
`TimeInstant`	`getResultTime()` Get result time.
`String`	`getResultType()` Get result type.
`NamedValue<org.locationtech.jts.geom.Geometry>`	`getSpatialFilteringProfileParameter()` Get spatial filtering profile parameter
`String`	`getTokenSeparator()` Get token separator.
`String`	`getTupleSeparator()` Get tuple separator.
`TimePeriod`	`getValidTime()` Get valid time.
`ObservationValue<?>`	`getValue()` Get observation values.
`boolean`	`isSetAdditionalMergeIndicator()`
`boolean`	`isSetCategoryParameter()` Check whether category parameter is set
`boolean`	`isSetDecimalSeparator()` Check whether decimal separator is set.
`boolean`	`isSetDepthParameter()` Check whether depth parameter is set.
`boolean`	`isSetHeightDepthParameter()`
`boolean`	`isSetHeightParameter()` Check whether height parameter is set
`boolean`	`isSetObservationID()` Check whether observation id is set.
`boolean`	`isSetParameter()` Check whether parameter is set
`boolean`	`isSetPhenomenonTime()`
`boolean`	`isSetRelatedObservations()` Check if related observations are set
`boolean`	`isSetResultQuality()`
`boolean`	`isSetResultTime()` Check whether result time is set.
`boolean`	`isSetResultType()` Check whether result type is set.
`boolean`	`isSetSpatialFilteringProfileParameter()` Check whether spatial filtering profile parameter is set
`boolean`	`isSetTokenSeparator()` Check whether token separator is set.
`boolean`	`isSetTupleSeparator()` Check whether tuple separator is set.
`boolean`	`isSetValidTime()` Check whether valid time is set.
`boolean`	`isSetValue()`
`boolean`	`isTemplateResultTime()` Check whether result time is template is set.
`protected boolean`	`mergeValues(ObservationValue<?> observationValue)` Merge observation values with passed observation values.
`void`	`mergeWithObservation(ObservationValue<?> observationValue)` Merge this observation with passed observation.
`void`	`mergeWithObservation(OmObservation sosObservation)` Merge this observation with passed observation.
`void`	`removeCategoryParameter()` Remove category parameter
`void`	`removeParameter(NamedValue<?> parameter)` Remove parameter from list
`void`	`removeSpatialFilteringProfileParameter()` Remove spatial filtering profile parameter
`OmObservation`	`setAdditionalMergeIndicator(String additionalMergeIndicator)`
`void`	`setDecimalSeparator(String decimalSeparator)` Set decimal separator.
`void`	`setNoDataValue(String noDataValue)` Set noData value.
`OmObservation`	`setObservationConstellation(OmObservationConstellation observationConstellation)` Set the observation constellation.
`void`	`setObservationID(String observationID)` Set observation ID.
`void`	`setParameter(Collection<NamedValue<?>> parameter)` Set parameter
`void`	`setRelatedObservations(Set<OmObservationContext> relatedObservations)` Set related observations
`OmObservation`	`setResultQuality(Set<OmResultQuality> qualityList)` Set result quality.
`void`	`setResultTime(TimeInstant resultTime)` Set result time.
`void`	`setResultType(String resultType)` Set result type.
`void`	`setTokenSeparator(String tokenSeparator)` Set token separator.
`void`	`setTupleSeparator(String tupleSeparator)` Set tuple separator.
`void`	`setValidTime(TimePeriod validTime)` Set valid time.
`void`	`setValue(ObservationValue<?> value)` Set observation values.

Methods inherited from class org.n52.shetland.ogc.gml.AbstractFeature
accept, copyTo, getDefaultElementEncoding, getXml, isEncoded, isSetDefaultElementEncoding, isSetXml, setDefaultElementEncoding, setXml, wasEncoded

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OmObservation
```
public OmObservation()
```
    constructor.
  - OmObservation
```
public OmObservation(String identifier)
```
    constructor.
    
    Parameters:
    
    identifier - Feature identifier
  - OmObservation
```
public OmObservation(CodeWithAuthority identifier)
```
    constructor.
    
    Parameters:
    
    identifier - Feature identifier
  - OmObservation
```
public OmObservation(CodeWithAuthority identifier,
                     String gmlId)
```
    constructor.
    
    Parameters:
    
    identifier - Feature identifier
    
    gmlId - GML id
- Method Detail
  - getObservationConstellation
```
public OmObservationConstellation getObservationConstellation()
```
    Get the observation constellation.
    
    Returns:
    
    the observationConstellation
  - setObservationConstellation
```
public OmObservation setObservationConstellation(OmObservationConstellation observationConstellation)
```
    Set the observation constellation.
    
    Parameters:
    
    observationConstellation - the observationConstellation to set
  - getObservationID
```
public String getObservationID()
```
    Get observation ID.
    
    Returns:
    
    the observationID
  - setObservationID
```
public void setObservationID(String observationID)
```
    Set observation ID.
    
    Parameters:
    
    observationID - the observationID to set
  - getPhenomenonTime
```
public Time getPhenomenonTime()
```
    Get phenomenon time.
    
    Returns:
    
    the phenomenonTime
  - isSetPhenomenonTime
```
public boolean isSetPhenomenonTime()
```
  - getResultTime
```
public TimeInstant getResultTime()
```
    Get result time.
    
    Returns:
    
    the resultTime
  - setResultTime
```
public void setResultTime(TimeInstant resultTime)
```
    Set result time.
    
    Parameters:
    
    resultTime - the resultTime to set
  - getValidTime
```
public TimePeriod getValidTime()
```
    Get valid time.
    
    Returns:
    
    the validTime
  - setValidTime
```
public void setValidTime(TimePeriod validTime)
```
    Set valid time.
    
    Parameters:
    
    validTime - the validTime to set
  - getResultType
```
public String getResultType()
```
    Get result type.
    
    Returns:
    
    the resultType
  - setResultType
```
public void setResultType(String resultType)
```
    Set result type.
    
    Parameters:
    
    resultType - the resultType to set
  - getTokenSeparator
```
public String getTokenSeparator()
```
    Get token separator.
    
    Returns:
    
    the tokenSeparator
  - setTokenSeparator
```
public void setTokenSeparator(String tokenSeparator)
```
    Set token separator.
    
    Parameters:
    
    tokenSeparator - the tokenSeparator to set
  - getNoDataValue
```
public String getNoDataValue()
```
    Get noData value.
    
    Returns:
    
    the noDataValue
  - setNoDataValue
```
public void setNoDataValue(String noDataValue)
```
    Set noData value.
    
    Parameters:
    
    noDataValue - the noDataValue to set
  - getTupleSeparator
```
public String getTupleSeparator()
```
    Get tuple separator.
    
    Returns:
    
    the tupleSeparator
  - setTupleSeparator
```
public void setTupleSeparator(String tupleSeparator)
```
    Set tuple separator.
    
    Parameters:
    
    tupleSeparator - the tupleSeparator to set
  - getDecimalSeparator
```
public String getDecimalSeparator()
```
    Get decimal separator.
    
    Returns:
    
    the decimalSeparator
  - setDecimalSeparator
```
public void setDecimalSeparator(String decimalSeparator)
```
    Set decimal separator.
    
    Parameters:
    
    decimalSeparator - the decimalSeparator to set
  - getValue
```
public ObservationValue<?> getValue()
```
    Get observation values.
    
    Returns:
    
    the values
  - setValue
```
public void setValue(ObservationValue<?> value)
```
    Set observation values.
    
    Parameters:
    
    value - the values to set
  - isSetValue
```
public boolean isSetValue()
```
  - mergeWithObservation
```
public void mergeWithObservation(OmObservation sosObservation)
```
    Merge this observation with passed observation.
    
    Parameters:
    
    sosObservation - Observation to merge
  - mergeWithObservation
```
public void mergeWithObservation(ObservationValue<?> observationValue)
```
    Merge this observation with passed observation.
    
    Parameters:
    
    observationValue - Observation to merge
  - mergeValues
```
protected boolean mergeValues(ObservationValue<?> observationValue)
```
    Merge observation values with passed observation values.
    
    Parameters:
    
    observationValue - Observation to merge
  - convertSingleValueToMultiValue
```
public TVPValue convertSingleValueToMultiValue(SingleObservationValue<?> singleValue)
```
    Convert SingleObservationValue to TVPValue.
    
    Parameters:
    
    singleValue - Single observation value
    
    Returns:
    
    Converted TVPValue value
  - isSetObservationID
```
public boolean isSetObservationID()
```
    Check whether observation id is set.
    
    Returns:
    
    true, if observation id is set
  - isSetTupleSeparator
```
public boolean isSetTupleSeparator()
```
    Check whether tuple separator is set.
    
    Returns:
    
    true, if tuple separator is set
  - isSetTokenSeparator
```
public boolean isSetTokenSeparator()
```
    Check whether token separator is set.
    
    Returns:
    
    true, if token separator is set
  - isSetDecimalSeparator
```
public boolean isSetDecimalSeparator()
```
    Check whether decimal separator is set.
    
    Returns:
    
    true, if decimal separator is set
  - isSetResultTime
```
public boolean isSetResultTime()
```
    Check whether result time is set.
    
    Returns:
    
    true, if result time is set
  - isTemplateResultTime
```
public boolean isTemplateResultTime()
```
    Check whether result time is template is set.
    
    Returns:
    
    true, if result time is template is set
  - isSetResultType
```
public boolean isSetResultType()
```
    Check whether result type is set.
    
    Returns:
    
    true, if result type is set
  - isSetValidTime
```
public boolean isSetValidTime()
```
    Check whether valid time is set.
    
    Returns:
    
    true, if valid time is set
  - getParameter
```
public Collection<NamedValue<?>> getParameter()
```
    Get parameter
    
    Returns:
    
    the parameter
  - setParameter
```
public void setParameter(Collection<NamedValue<?>> parameter)
```
    Set parameter
    
    Parameters:
    
    parameter - the parameter to set
  - addParameter
```
public void addParameter(NamedValue<?> namedValue)
```
    Add parameter
    
    Parameters:
    
    namedValue - the namedValue to add to parameter
  - getParameterHolder
```
public ParameterHolder getParameterHolder()
```
  - isSetParameter
```
public boolean isSetParameter()
```
    Check whether parameter is set
    
    Returns:
    
    true, if parameter is set
  - isSetSpatialFilteringProfileParameter
```
public boolean isSetSpatialFilteringProfileParameter()
```
    Check whether spatial filtering profile parameter is set
    
    Returns:
    
    true, if spatial filtering profile parameter is set
  - removeSpatialFilteringProfileParameter
```
public void removeSpatialFilteringProfileParameter()
```
    Remove spatial filtering profile parameter
  - removeParameter
```
public void removeParameter(NamedValue<?> parameter)
```
    Remove parameter from list
    
    Parameters:
    
    parameter - Parameter to remove
  - addSpatialFilteringProfileParameter
```
public OmObservation addSpatialFilteringProfileParameter(org.locationtech.jts.geom.Geometry samplingGeometry)
```
    Add sampling geometry to observation
    
    Parameters:
    
    samplingGeometry - The sampling geometry to set
    
    Returns:
    
    this
  - getSpatialFilteringProfileParameter
```
public NamedValue<org.locationtech.jts.geom.Geometry> getSpatialFilteringProfileParameter()
```
    Get spatial filtering profile parameter
    
    Returns:
    
    Spatial filtering profile parameter
  - isSetHeightParameter
```
public boolean isSetHeightParameter()
```
    Check whether height parameter is set
    
    Returns:
    
    true, if height parameter is set
  - getHeightParameter
```
public NamedValue<BigDecimal> getHeightParameter()
```
    Get height parameter
    
    Returns:
    
    Height parameter
  - isSetDepthParameter
```
public boolean isSetDepthParameter()
```
    Check whether depth parameter is set.
    
    Returns:
    
    true, if depth parameter is set
  - getDepthParameter
```
public NamedValue<BigDecimal> getDepthParameter()
```
    Get depth parameter
    
    Returns:
    
    Depth parameter
  - isSetHeightDepthParameter
```
public boolean isSetHeightDepthParameter()
```
  - getHeightDepthParameter
```
public NamedValue<BigDecimal> getHeightDepthParameter()
```
  - isSetCategoryParameter
```
public boolean isSetCategoryParameter()
```
    Check whether category parameter is set
    
    Returns:
    
    true, if category parameter is set
  - removeCategoryParameter
```
public void removeCategoryParameter()
```
    Remove category parameter
  - addCategoryParameter
```
public OmObservation addCategoryParameter(String category)
```
    Add category to observation
    
    Parameters:
    
    category - The category to set
    
    Returns:
    
    this
  - addCategoryParameter
```
public OmObservation addCategoryParameter(TextValue category)
```
  - addCategoryParameter
```
public OmObservation addCategoryParameter(NamedValue<String> categoryParameter)
```
  - getCategoryParameter
```
public NamedValue<String> getCategoryParameter()
```
    Get category parameter
    
    Returns:
    
    category parameter
  - cloneTemplate
```
public OmObservation cloneTemplate()
```
  - cloneTemplate
```
public OmObservation cloneTemplate(boolean withIdentifierNameDesription)
```
  - cloneTemplate
```
protected OmObservation cloneTemplate(OmObservation clone)
```
  - copyTo
```
public OmObservation copyTo(OmObservation copyOf)
```
  - getGmlId
```
public String getGmlId()
```
    Description copied from class: AbstractGML
    
    Get GML id
    
    Overrides:
    
    getGmlId in class AbstractGML
    
    Returns:
    
    GML id
  - setResultQuality
```
public OmObservation setResultQuality(Set<OmResultQuality> qualityList)
```
    Set result quality.
    
    Parameters:
    
    qualityList - Result quality to set
    
    Returns:
    
    this
  - addResultQuality
```
public OmObservation addResultQuality(Set<OmResultQuality> qualityList)
```
  - addResultQuality
```
public OmObservation addResultQuality(OmResultQuality qualityList)
```
  - getResultQuality
```
public Set<OmResultQuality> getResultQuality()
```
    Get result quality.
    
    Returns:
    
    Result quality
  - isSetResultQuality
```
public boolean isSetResultQuality()
```
  - getRelatedObservations
```
public Set<OmObservationContext> getRelatedObservations()
```
    Get related observations
    
    Returns:
    
    the relatedObservations
  - setRelatedObservations
```
public void setRelatedObservations(Set<OmObservationContext> relatedObservations)
```
    Set related observations
    
    Parameters:
    
    relatedObservations - the relatedObservations to set
  - addRelatedObservations
```
public void addRelatedObservations(Set<OmObservationContext> relatedObservations)
```
    Add related observations
    
    Parameters:
    
    relatedObservations - the relatedObservations to set
  - addRelatedObservation
```
public void addRelatedObservation(OmObservationContext relatedObservation)
```
    Add a related observation
    
    Parameters:
    
    relatedObservation - the relatedObservation to add
  - isSetRelatedObservations
```
public boolean isSetRelatedObservations()
```
    Check if related observations are set
    
    Returns:
    
    true, if related observations are set
  - setAdditionalMergeIndicator
```
public OmObservation setAdditionalMergeIndicator(String additionalMergeIndicator)
```
  - getAdditionalMergeIndicator
```
public String getAdditionalMergeIndicator()
```
  - isSetAdditionalMergeIndicator
```
public boolean isSetAdditionalMergeIndicator()
```
  - checkForMerge
```
public boolean checkForMerge(OmObservation observation)
```
  - checkForMerge
```
public boolean checkForMerge(OmObservation observation,
                             ObservationMergeIndicator indicator)
```

Class OmObservation

Constructor Summary

Method Summary

Methods inherited from class org.n52.shetland.ogc.gml.AbstractFeature

Methods inherited from class org.n52.shetland.ogc.gml.AbstractGML

Methods inherited from class java.lang.Object

Constructor Detail

OmObservation

OmObservation

OmObservation

OmObservation

Method Detail

getObservationConstellation

setObservationConstellation

getObservationID

setObservationID

getPhenomenonTime

isSetPhenomenonTime

getResultTime

setResultTime

getValidTime

setValidTime

getResultType

setResultType

getTokenSeparator

setTokenSeparator

getNoDataValue

setNoDataValue

getTupleSeparator

setTupleSeparator

getDecimalSeparator

setDecimalSeparator

getValue

setValue

isSetValue

mergeWithObservation

mergeWithObservation

mergeValues

convertSingleValueToMultiValue

isSetObservationID

isSetTupleSeparator

isSetTokenSeparator

isSetDecimalSeparator

isSetResultTime

isTemplateResultTime

isSetResultType

isSetValidTime

getParameter

setParameter

addParameter

getParameterHolder

isSetParameter

isSetSpatialFilteringProfileParameter

removeSpatialFilteringProfileParameter

removeParameter

addSpatialFilteringProfileParameter

getSpatialFilteringProfileParameter

isSetHeightParameter

getHeightParameter

isSetDepthParameter

getDepthParameter

isSetHeightDepthParameter

getHeightDepthParameter

isSetCategoryParameter

removeCategoryParameter

addCategoryParameter

addCategoryParameter

addCategoryParameter

getCategoryParameter

cloneTemplate

cloneTemplate

cloneTemplate

copyTo

getGmlId

setResultQuality

addResultQuality

addResultQuality

getResultQuality

isSetResultQuality

getRelatedObservations