Class DefaultKeywords

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultKeywords

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Keywords

public class DefaultKeywords
extends ISOMetadata
implements Keywords

Keywords, their type and reference source. The following property is mandatory in a well-formed metadata according ISO 19115:

MD_Keywords └─keyword…… Commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.

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

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­Keywords()	Constructs an initially empty keywords.
Default­Keywords(Char­Sequence... keywords)	Creates keywords initialized to the given key word.
Default­Keywords(Keywords object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Keywords	cast­Or­Copy(Keywords object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Default­Keyword­Class	get­Keyword­Class()	Returns the user-defined categorization of groups of keywords that extend or are orthogonal to the standardized keyword type codes.
Collection<International­String>	get­Keywords()	Returns commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.
Citation	get­Thesaurus­Name()	Returns the name of the formally registered thesaurus or a similar authoritative source of keywords.
Keyword­Type	get­Type()	Returns the subject matter used to group similar keywords.
void	set­Keyword­Class(Default­Keyword­Class new­Value)	Sets the user-defined categorization of groups of keywords.
void	set­Keywords(Collection<? extends International­String> new­Values)	Sets commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.
void	set­Thesaurus­Name(Citation new­Value)	Sets the name of the formally registered thesaurus or a similar authoritative source of keywords.
void	set­Type(Keyword­Type new­Value)	Sets the subject matter used to group similar keywords.

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

DefaultKeywords

public DefaultKeywords()

Constructs an initially empty keywords.

DefaultKeywords

public DefaultKeywords(CharSequence... keywords)

Creates keywords initialized to the given key word.

Parameters:

keywords - commonly used words or formalised words or phrases used to describe the subject, or null if none.

DefaultKeywords

public DefaultKeywords(Keywords 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.

See Also:

• cast­Or­Copy(Keywords)

Method Details

castOrCopy

public static DefaultKeywords castOrCopy(Keywords 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 returns null.
• Otherwise if the given object is already an instance of Default­Keywords, then it is returned unchanged.
• Otherwise a new Default­Keywords instance 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 null 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.

getKeywords

public Collection<InternationalString> getKeywords()

Returns commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.

Specified by:

get­Keywords in interface Keywords

Returns:

word(s) or phrase(s) used to describe the subject.

setKeywords

public void setKeywords(Collection<? extends InternationalString> newValues)

Sets commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.

Parameters:

new­Values - the new keywords.

getType

public KeywordType getType()

Returns the subject matter used to group similar keywords.

Specified by:

get­Type in interface Keywords

Returns:

subject matter used to group similar keywords, or null.

setType

public void setType(KeywordType newValue)

Sets the subject matter used to group similar keywords.

Parameters:

new­Value - the new keyword type.

getThesaurusName

public Citation getThesaurusName()

Returns the name of the formally registered thesaurus or a similar authoritative source of keywords.

Specified by:

get­Thesaurus­Name in interface Keywords

Returns:

name of registered thesaurus or similar authoritative source of keywords, or null.

setThesaurusName

public void setThesaurusName(Citation newValue)

Sets the name of the formally registered thesaurus or a similar authoritative source of keywords.

Parameters:

new­Value - the new thesaurus name.

getKeywordClass

@UML(identifier="keywordClass",
     obligation=OPTIONAL,
     specification=ISO_19115)
public DefaultKeywordClass getKeywordClass()

Returns the user-defined categorization of groups of keywords that extend or are orthogonal to the standardized keyword type codes.

Upcoming API change — generalization
The element type will be changed to the Keyword­Class interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Returns:

user-defined categorization of groups of keywords, or null if none.

Since:

0.5

setKeywordClass

public void setKeywordClass(DefaultKeywordClass newValue)

Sets the user-defined categorization of groups of keywords.

Upcoming API change — generalization
The argument type will be changed to the Keyword­Class interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Parameters:

new­Value - new user-defined categorization of groups of keywords.

Since:

0.5