Class DefaultKeywordClass

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultKeywordClass

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

@TitleProperty(name="className")
public class DefaultKeywordClass
extends ISOMetadata

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_Keyword­Class ├─class­Name……………………… 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 Keyword­Class 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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Keyword­Class()	Constructs an initially empty keyword class.
Default­Keyword­Class(Char­Sequence class­Name, Citation ontology)	Creates keyword class initialized to the given key name and ontology.
Default­Keyword­Class(Default­Keyword­Class object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
International­String	get­Class­Name()	Returns a label for the keyword category in natural language.
URI	get­Concept­Identifier()	Returns the URI of concept in the ontology specified by the ontology citation.
Citation	get­Ontology()	Returns a reference that binds the keyword class to a formal conceptualization of a knowledge domain.
void	set­Class­Name(International­String new­Value)	Sets a label for the keyword category in natural language.
void	set­Concept­Identifier(URI new­Value)	Sets the URI of concept in the ontology specified by the ontology citation.
void	set­Ontology(Citation new­Value)	Sets a reference that binds the keyword class to a formal conceptualization of a knowledge domain.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultKeywordClass

public DefaultKeywordClass()

Constructs an initially empty keyword class.

DefaultKeywordClass

public DefaultKeywordClass(CharSequence className,
 Citation ontology)

Creates keyword class initialized to the given key name and ontology.

Parameters:

class­Name - 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

public DefaultKeywordClass(DefaultKeywordClass object)

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, or null if none.

Method Details

getClassName

public InternationalString getClassName()

Returns a label for the keyword category in natural language.

Returns:

the keyword category in natural language.

setClassName

public void setClassName(InternationalString newValue)

Sets a label for the keyword category in natural language.

Parameters:

new­Value - the new keyword category in natural language.

getConceptIdentifier

public URI 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

public void setConceptIdentifier(URI newValue)

Sets the URI of concept in the ontology specified by the ontology citation.

Parameters:

new­Value - the new URI of concept in the ontology.

getOntology

public 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(Citation newValue)

Sets a reference that binds the keyword class to a formal conceptualization of a knowledge domain.

Parameters:

new­Value - the new reference that binds the keyword class to a formal conceptualization.