Class DefaultKeywordClass
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.identification.DefaultKeywordClass
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
Specification of a class to categorize keywords in a domain-specific vocabulary
that has a binding to a formal ontology.
The following properties are mandatory in a well-formed metadata according ISO 19115:
MD_KeywordClass
├─className………………………
Character string to label the keyword category in natural language.
└─ontology…………………………
Reference that binds the keyword class to a formal conceptualization of a knowledge domain.
├─title………………………
Name by which the cited resource is known.
└─date…………………………
Reference date for the cited resource.Note on International Standard versions
This class is derived from a new type defined in the ISO 19115 international standard published in 2014, while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. When the interface will become available, all references to this implementation class in Apache SIS will be replaced be references to the
This class is derived from a new type defined in the ISO 19115 international standard published in 2014, while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. When the interface will become available, all references to this implementation class in Apache SIS will be replaced be references to the
KeywordClass
interface.
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.5
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.util.InternationalString
A character string to label the keyword category in natural language.private URI
URI of concept in the ontology specified by the ontology citation.private org.opengis.metadata.citation.Citation
Reference that binds the keyword class to a formal conceptualization of a knowledge domain.private static final long
Serial number for compatibility with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty keyword class.DefaultKeywordClass
(CharSequence className, org.opengis.metadata.citation.Citation ontology) Creates keyword class initialized to the given key name and ontology.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionorg.opengis.util.InternationalString
Returns a label for the keyword category in natural language.Returns the URI of concept in the ontology specified by the ontology citation.org.opengis.metadata.citation.Citation
Returns a reference that binds the keyword class to a formal conceptualization of a knowledge domain.void
setClassName
(org.opengis.util.InternationalString newValue) Sets a label for the keyword category in natural language.void
setConceptIdentifier
(URI newValue) Sets the URI of concept in the ontology specified by the ontology citation.void
setOntology
(org.opengis.metadata.citation.Citation newValue) Sets a reference that binds the keyword class to a formal conceptualization of a knowledge domain.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for compatibility with different versions.- See Also:
-
className
private org.opengis.util.InternationalString classNameA character string to label the keyword category in natural language. -
conceptIdentifier
URI of concept in the ontology specified by the ontology citation. -
ontology
private org.opengis.metadata.citation.Citation ontologyReference that binds the keyword class to a formal conceptualization of a knowledge domain.
-
-
Constructor Details
-
DefaultKeywordClass
public DefaultKeywordClass()Constructs an initially empty keyword class. -
DefaultKeywordClass
Creates keyword class initialized to the given key name and ontology.- Parameters:
className
- a character string to label the keyword category in natural language.ontology
- reference that binds the keyword class to a formal conceptualization of a knowledge domain.
-
DefaultKeywordClass
Constructs 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.- Parameters:
object
- the metadata to copy values from, ornull
if none.
-
-
Method Details
-
getClassName
public org.opengis.util.InternationalString getClassName()Returns a label for the keyword category in natural language.- Returns:
- the keyword category in natural language.
-
setClassName
public void setClassName(org.opengis.util.InternationalString newValue) Sets a label for the keyword category in natural language.- Parameters:
newValue
- the new keyword category in natural language.
-
getConceptIdentifier
Returns the URI of concept in the ontology specified by the ontology citation.- Returns:
- URI of concept in the ontology, or
null
if none.
-
setConceptIdentifier
Sets the URI of concept in the ontology specified by the ontology citation.- Parameters:
newValue
- the new URI of concept in the ontology.
-
getOntology
public org.opengis.metadata.citation.Citation getOntology()Returns a reference that binds the keyword class to a formal conceptualization of a knowledge domain.- Returns:
- a reference that binds the keyword class to a formal conceptualization.
-
setOntology
public void setOntology(org.opengis.metadata.citation.Citation newValue) Sets a reference that binds the keyword class to a formal conceptualization of a knowledge domain.- Parameters:
newValue
- the new reference that binds the keyword class to a formal conceptualization.
-