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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstruct 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.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionReturns a SIS metadata implementation with the values of the given arbitrary implementation.Condition under which the extended element is mandatory.Code which identifies the kind of value provided in the extended element.Definition of the extended element.Deprecated.Removed as of ISO 19115:2014.Valid values that can be assigned to the extended element.Maximum occurrence of the extended element.getName()Name of the extended metadata element.Obligation of the extended element.Name of the metadata entity(s) under which this extended metadata element may appear.Returns the reason for creating the extended element.Deprecated.As of ISO 19115:2014, replaced bygetRationale().getRule()Specifies how the extended element relates to other existing elements and entities.Deprecated.Removed as of ISO 19115:2014.Name of the person or organization creating the extended element.voidsetCondition(InternationalString newValue) Sets the condition under which the extended element is mandatory.voidsetDataType(Datatype newValue) Sets the code which identifies the kind of value provided in the extended element.voidsetDefinition(InternationalString newValue) Sets the definition of the extended element.voidsetDomainCode(Integer newValue) Deprecated.Removed as of ISO 19115:2014.voidsetDomainValue(InternationalString newValue) Sets the valid values that can be assigned to the extended element.voidsetMaximumOccurrence(Integer newValue) Sets the maximum occurrence of the extended element.voidSets the name of the extended metadata element.voidsetObligation(Obligation newValue) Sets the obligation of the extended element.voidsetParentEntity(Collection<? extends String> newValues) Sets the name of the metadata entity(s) under which this extended metadata element may appear.voidsetRationale(InternationalString newValue) Sets the reason for creating the extended element.voidsetRationales(Collection<? extends InternationalString> newValues) Deprecated.As of ISO 19115:2014, replaced bysetRationale(InternationalString).voidsetRule(InternationalString newValue) Sets how the extended element relates to other existing elements and entities.voidsetShortName(String newValue) Deprecated.Removed as of ISO 19115:2014.voidsetSources(Collection<? extends ResponsibleParty> newValues) Sets the name of the person or organization creating the extended element.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultExtendedElementInformationpublic DefaultExtendedElementInformation()Construct an initially empty extended element information.
- 
DefaultExtendedElementInformationpublic 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.
 
- 
DefaultExtendedElementInformationConstructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because 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, or- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 DefaultExtendedElementInformationinstance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
 - Parameters:
- object- the object to get as a SIS implementation, or- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getNameName of the extended metadata element.- Specified by:
- getNamein interface- ExtendedElementInformation
- Returns:
- name of the extended metadata element, or null.
 
- 
setNameSets the name of the extended metadata element.- Parameters:
- newValue- the new name.
 
- 
getShortNameDeprecated.Removed as of ISO 19115:2014.Short form suitable for use in an implementation method such as XML or SGML.- Specified by:
- getShortNamein interface- ExtendedElementInformation
- Returns:
- short form suitable for use in an implementation method such as XML or SGML, or null.
 
- 
setShortNameDeprecated.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.
 
- 
getDomainCodeDeprecated.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:
- getDomainCodein interface- ExtendedElementInformation
- Returns:
- three digit code assigned to the extended element, or null.
 
- 
setDomainCodeDeprecated.Removed as of ISO 19115:2014.Sets a three digit code assigned to the extended element.- Parameters:
- newValue- the new domain code.
 
- 
getDefinitionDefinition of the extended element.- Specified by:
- getDefinitionin interface- ExtendedElementInformation
- Returns:
- definition of the extended element, or null.
 
- 
setDefinitionSets the definition of the extended element.- Parameters:
- newValue- the new definition.
 
- 
getObligationObligation of the extended element.- Specified by:
- getObligationin interface- ExtendedElementInformation
- Returns:
- obligation of the extended element, or null.
 
- 
setObligationSets the obligation of the extended element.- Parameters:
- newValue- the new obligation.
 
- 
getConditionCondition under which the extended element is mandatory. Returns a non-null value only if the obligation is conditional.- Specified by:
- getConditionin interface- ExtendedElementInformation
- Returns:
- the condition under which the extended element is mandatory, or null.
 
- 
setConditionSets the condition under which the extended element is mandatory.- Parameters:
- newValue- the new condition.
 
- 
getDataTypeCode which identifies the kind of value provided in the extended element.- Specified by:
- getDataTypein interface- ExtendedElementInformation
- Returns:
- the kind of value provided in the extended element, or null.
 
- 
setDataTypeSets the code which identifies the kind of value provided in the extended element.- Parameters:
- newValue- the new data type.
 
- 
getMaximumOccurrenceMaximum occurrence of the extended element. Returnsnullif it does not apply, for example if the data type is enumeration, code list or code list element.- Specified by:
- getMaximumOccurrencein interface- ExtendedElementInformation
- Returns:
- maximum occurrence of the extended element, or null.
 
- 
setMaximumOccurrenceSets the maximum occurrence of the extended element.- Parameters:
- newValue- the new maximum occurrence, or- null.
- Throws:
- IllegalArgumentException- if the given value is negative.
 
- 
getDomainValueValid values that can be assigned to the extended element. Returnsnullif it doesn't apply, for example if the data type is enumeration, code list or code list element.- Specified by:
- getDomainValuein interface- ExtendedElementInformation
- Returns:
- valid values that can be assigned to the extended element, or null.
 
- 
setDomainValueSets the valid values that can be assigned to the extended element.- Parameters:
- newValue- the new domain value.
 
- 
getParentEntityName 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:
- getParentEntityin interface- ExtendedElementInformation
- Returns:
- name of the metadata entity(s) under which this extended metadata element may appear.
 
- 
setParentEntitySets the name of the metadata entity(s) under which this extended metadata element may appear.- Parameters:
- newValues- the new parent entity.
 
- 
getRuleSpecifies how the extended element relates to other existing elements and entities.- Specified by:
- getRulein interface- ExtendedElementInformation
- Returns:
- how the extended element relates to other existing elements and entities, or null.
 
- 
setRuleSets 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
 
- 
setRationaleSets the reason for creating the extended element.- Parameters:
- newValue- the new rationale.
- Since:
- 0.5
 
- 
getRationalesDeprecated.As of ISO 19115:2014, replaced bygetRationale().- Specified by:
- getRationalesin interface- ExtendedElementInformation
- Returns:
- reason for creating the extended element.
 
- 
setRationalesDeprecated.As of ISO 19115:2014, replaced bysetRationale(InternationalString).- Parameters:
- newValues- the new rationales.
 
- 
getSourcesName of the person or organization creating the extended element.Upcoming API change — generalization
 As of ISO 19115:2014,ResponsiblePartyis replaced by theResponsibilityparent interface. This change may be applied in GeoAPI 4.0.- Specified by:
- getSourcesin interface- ExtendedElementInformation
- Returns:
- name of the person or organization creating the extended element.
 
- 
setSourcesSets the name of the person or organization creating the extended element.Upcoming API change — generalization
 As of ISO 19115:2014,ResponsiblePartyis replaced by theResponsibilityparent interface. This change may be applied in GeoAPI 4.0.- Parameters:
- newValues- the new sources.
 
 
-