Package org.apache.sis.metadata.iso
Class DefaultExtendedElementInformation
- Object
-
- AbstractMetadata
-
- ModifiableMetadata
-
- ISOMetadata
-
- DefaultExtendedElementInformation
-
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,ExtendedElementInformation
@TitleProperty(name="name") public class DefaultExtendedElementInformation extends ISOMetadata implements ExtendedElementInformation
New metadata element, not found in ISO 19115, which is required to describe geographic data. Metadata elements are contained in a metadata extension information. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:MD_ExtendedElementInformation
├─name………………………………………………………
Name of the extended metadata element.├─definition………………………………………
Definition of the extended element.├─obligation………………………………………
Obligation of the extended element.├─condition…………………………………………
Condition under which the extended element is mandatory.├─dataType……………………………………………
Code which identifies the kind of value provided in the extended element.├─maximumOccurrence……………………
Maximum occurrence of the extended element.├─domainValue……………………………………
Valid values that can be assigned to the extended element.├─parentEntity…………………………………
Name of the metadata entity(s) under which this extended metadata element may appear.├─rule………………………………………………………
Specifies how the extended element relates to other existing elements and entities.└─source…………………………………………………
Name of the person or organisation creating the extended element.├─party…………………………………………
Information about the parties.│ └─name…………………………………
Name of the party.└─role……………………………………………
Function performed by the responsible party.Limitations:
- Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
- Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use
XML
instead.
- Since:
- 0.3
- See Also:
- Serialized Form
Defined in the
sis-metadata
module
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State
-
-
Field Summary
-
Fields inherited from class ISOMetadata
identifiers
-
-
Constructor Summary
Constructors Constructor Description DefaultExtendedElementInformation()
Construct an initially empty extended element information.DefaultExtendedElementInformation(String name, CharSequence definition, CharSequence condition, Datatype dataType, String parentEntity, CharSequence rule, ResponsibleParty source)
Create an extended element information initialized to the given values.DefaultExtendedElementInformation(ExtendedElementInformation object)
Constructs a new instance initialized with the values from the specified metadata object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static DefaultExtendedElementInformation
castOrCopy(ExtendedElementInformation object)
Returns a SIS metadata implementation with the values of the given arbitrary implementation.InternationalString
getCondition()
Condition under which the extended element is mandatory.Datatype
getDataType()
Code which identifies the kind of value provided in the extended element.InternationalString
getDefinition()
Definition of the extended element.Integer
getDomainCode()
Deprecated.Removed as of ISO 19115:2014.InternationalString
getDomainValue()
Valid values that can be assigned to the extended element.Integer
getMaximumOccurrence()
Maximum occurrence of the extended element.String
getName()
Name of the extended metadata element.Obligation
getObligation()
Obligation of the extended element.Collection<String>
getParentEntity()
Name of the metadata entity(s) under which this extended metadata element may appear.InternationalString
getRationale()
Returns the reason for creating the extended element.Collection<InternationalString>
getRationales()
Deprecated.As of ISO 19115:2014, replaced bygetRationale()
.InternationalString
getRule()
Specifies how the extended element relates to other existing elements and entities.String
getShortName()
Deprecated.Removed as of ISO 19115:2014.Collection<ResponsibleParty>
getSources()
Name of the person or organization creating the extended element.void
setCondition(InternationalString newValue)
Sets the condition under which the extended element is mandatory.void
setDataType(Datatype newValue)
Sets the code which identifies the kind of value provided in the extended element.void
setDefinition(InternationalString newValue)
Sets the definition of the extended element.void
setDomainCode(Integer newValue)
Deprecated.Removed as of ISO 19115:2014.void
setDomainValue(InternationalString newValue)
Sets the valid values that can be assigned to the extended element.void
setMaximumOccurrence(Integer newValue)
Sets the maximum occurrence of the extended element.void
setName(String newValue)
Sets the name of the extended metadata element.void
setObligation(Obligation newValue)
Sets the obligation of the extended element.void
setParentEntity(Collection<? extends String> newValues)
Sets the name of the metadata entity(s) under which this extended metadata element may appear.void
setRationale(InternationalString newValue)
Sets the reason for creating the extended element.void
setRationales(Collection<? extends InternationalString> newValues)
Deprecated.As of ISO 19115:2014, replaced bysetRationale(InternationalString)
.void
setRule(InternationalString newValue)
Sets how the extended element relates to other existing elements and entities.void
setShortName(String newValue)
Deprecated.Removed as of ISO 19115:2014.void
setSources(Collection<? extends ResponsibleParty> newValues)
Sets the name of the person or organization creating the extended element.-
Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
-
Methods inherited from class ModifiableMetadata
checkWritePermission, checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, unmodifiable, writeCollection, writeList, writeMap, writeSet
-
Methods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
-
-
-
Constructor Detail
-
DefaultExtendedElementInformation
public DefaultExtendedElementInformation()
Construct an initially empty extended element information.
-
DefaultExtendedElementInformation
public DefaultExtendedElementInformation(String name, CharSequence definition, CharSequence condition, Datatype dataType, String parentEntity, CharSequence rule, ResponsibleParty source)
Create an extended element information initialized to the given values.- Parameters:
name
- the name of the extended metadata element.definition
- the definition of the extended element.condition
- the condition under which the extended element is mandatory.dataType
- the code which identifies the kind of value provided in the extended element.parentEntity
- the name of the metadata entity(s) under which this extended metadata element may appear.rule
- how the extended element relates to other existing elements and entities.source
- the name of the person or organization creating the extended element.
-
DefaultExtendedElementInformation
public DefaultExtendedElementInformation(ExtendedElementInformation object)
Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since the other metadata contained in the given object are not recursively copied.Note on properties validation: This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.- Parameters:
object
- the metadata to copy values from, ornull
if none.- See Also:
castOrCopy(ExtendedElementInformation)
-
-
Method Detail
-
castOrCopy
public static DefaultExtendedElementInformation castOrCopy(ExtendedElementInformation object)
Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:- If the given object is
null
, then this method returnsnull
. - Otherwise if the given object is already an instance of
DefaultExtendedElementInformation
, then it is returned unchanged. - Otherwise a new
DefaultExtendedElementInformation
instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since the other metadata contained in the given object are not recursively copied.
- Parameters:
object
- the object to get as a SIS implementation, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if the argument was null.
- If the given object is
-
getName
public String getName()
Name of the extended metadata element.- Specified by:
getName
in interfaceExtendedElementInformation
- Returns:
- name of the extended metadata element, or
null
.
-
setName
public void setName(String newValue)
Sets the name of the extended metadata element.- Parameters:
newValue
- the new name.
-
getShortName
@Deprecated public String getShortName()
Deprecated.Removed as of ISO 19115:2014.Short form suitable for use in an implementation method such as XML or SGML.- Specified by:
getShortName
in interfaceExtendedElementInformation
- Returns:
- short form suitable for use in an implementation method such as XML or SGML, or
null
.
-
setShortName
@Deprecated public void setShortName(String newValue)
Deprecated.Removed as of ISO 19115:2014.Sets a short form suitable for use in an implementation method such as XML or SGML.- Parameters:
newValue
- the new short name.
-
getDomainCode
@Deprecated public Integer getDomainCode()
Deprecated.Removed as of ISO 19115:2014.Three digit code assigned to the extended element. Returns a non-null value only if the data type is code list element.- Specified by:
getDomainCode
in interfaceExtendedElementInformation
- Returns:
- three digit code assigned to the extended element, or
null
.
-
setDomainCode
@Deprecated public void setDomainCode(Integer newValue)
Deprecated.Removed as of ISO 19115:2014.Sets a three digit code assigned to the extended element.- Parameters:
newValue
- the new domain code.
-
getDefinition
public InternationalString getDefinition()
Definition of the extended element.- Specified by:
getDefinition
in interfaceExtendedElementInformation
- Returns:
- definition of the extended element, or
null
.
-
setDefinition
public void setDefinition(InternationalString newValue)
Sets the definition of the extended element.- Parameters:
newValue
- the new definition.
-
getObligation
public Obligation getObligation()
Obligation of the extended element.- Specified by:
getObligation
in interfaceExtendedElementInformation
- Returns:
- obligation of the extended element, or
null
.
-
setObligation
public void setObligation(Obligation newValue)
Sets the obligation of the extended element.- Parameters:
newValue
- the new obligation.
-
getCondition
public InternationalString getCondition()
Condition under which the extended element is mandatory. Returns a non-null value only if the obligation is conditional.- Specified by:
getCondition
in interfaceExtendedElementInformation
- Returns:
- the condition under which the extended element is mandatory, or
null
.
-
setCondition
public void setCondition(InternationalString newValue)
Sets the condition under which the extended element is mandatory.- Parameters:
newValue
- the new condition.
-
getDataType
public Datatype getDataType()
Code which identifies the kind of value provided in the extended element.- Specified by:
getDataType
in interfaceExtendedElementInformation
- Returns:
- the kind of value provided in the extended element, or
null
.
-
setDataType
public void setDataType(Datatype newValue)
Sets the code which identifies the kind of value provided in the extended element.- Parameters:
newValue
- the new data type.
-
getMaximumOccurrence
@ValueRange(minimum=0.0) public Integer getMaximumOccurrence()
Maximum occurrence of the extended element. Returnsnull
if it does not apply, for example if the data type is enumeration, code list or code list element.- Specified by:
getMaximumOccurrence
in interfaceExtendedElementInformation
- Returns:
- maximum occurrence of the extended element, or
null
.
-
setMaximumOccurrence
public void setMaximumOccurrence(Integer newValue)
Sets the maximum occurrence of the extended element.- Parameters:
newValue
- the new maximum occurrence, ornull
.- Throws:
IllegalArgumentException
- if the given value is negative.
-
getDomainValue
public InternationalString getDomainValue()
Valid values that can be assigned to the extended element. Returnsnull
if it doesn't apply, for example if the data type is enumeration, code list or code list element.- Specified by:
getDomainValue
in interfaceExtendedElementInformation
- Returns:
- valid values that can be assigned to the extended element, or
null
.
-
setDomainValue
public void setDomainValue(InternationalString newValue)
Sets the valid values that can be assigned to the extended element.- Parameters:
newValue
- the new domain value.
-
getParentEntity
public Collection<String> getParentEntity()
Name of the metadata entity(s) under which this extended metadata element may appear. The name(s) may be standard metadata element(s) or other extended metadata element(s).- Specified by:
getParentEntity
in interfaceExtendedElementInformation
- Returns:
- name of the metadata entity(s) under which this extended metadata element may appear.
-
setParentEntity
public void setParentEntity(Collection<? extends String> newValues)
Sets the name of the metadata entity(s) under which this extended metadata element may appear.- Parameters:
newValues
- the new parent entity.
-
getRule
public InternationalString getRule()
Specifies how the extended element relates to other existing elements and entities.- Specified by:
getRule
in interfaceExtendedElementInformation
- Returns:
- how the extended element relates to other existing elements and entities, or
null
.
-
setRule
public void setRule(InternationalString newValue)
Sets how the extended element relates to other existing elements and entities.- Parameters:
newValue
- the new rule.
-
getRationale
@UML(identifier="rationale", obligation=OPTIONAL, specification=ISO_19115) public InternationalString getRationale()
Returns the reason for creating the extended element.- Returns:
- reason for creating the extended element, or
null
. - Since:
- 0.5
-
setRationale
public void setRationale(InternationalString newValue)
Sets the reason for creating the extended element.- Parameters:
newValue
- the new rationale.- Since:
- 0.5
-
getRationales
@Deprecated public Collection<InternationalString> getRationales()
Deprecated.As of ISO 19115:2014, replaced bygetRationale()
.- Specified by:
getRationales
in interfaceExtendedElementInformation
- Returns:
- reason for creating the extended element.
-
setRationales
@Deprecated public void setRationales(Collection<? extends InternationalString> newValues)
Deprecated.As of ISO 19115:2014, replaced bysetRationale(InternationalString)
.- Parameters:
newValues
- the new rationales.
-
getSources
public Collection<ResponsibleParty> getSources()
Name of the person or organization creating the extended element.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change may be applied in GeoAPI 4.0.- Specified by:
getSources
in interfaceExtendedElementInformation
- Returns:
- name of the person or organization creating the extended element.
-
setSources
public void setSources(Collection<? extends ResponsibleParty> newValues)
Sets the name of the person or organization creating the extended element.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change may be applied in GeoAPI 4.0.- Parameters:
newValues
- the new sources.
-
-