Class DefaultDataIdentification

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractIdentification

DefaultDataIdentification

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Data­Identification, Identification

public class DefaultDataIdentification
extends AbstractIdentification
implements DataIdentification

Information required to identify a dataset. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_Data­Identification ├─citation……………………………………… Citation data for the resource(s). │ ├─title…………………………………… Name by which the cited resource is known. │ └─date……………………………………… Reference date for the cited resource. ├─abstract……………………………………… Brief narrative summary of the content of the resource(s). ├─language……………………………………… Language(s) used within the dataset. ├─character­Set…………………………… Full name of the character coding standard(s) used for the dataset. ├─topic­Category………………………… Main theme(s) of the dataset. └─extent…………………………………………… Bounding polygon, vertical, and temporal extent of the dataset. ├─description…………………… The spatial and temporal extent for the referring object. ├─geographic­Element…… Geographic component of the extent of the referring object. ├─temporal­Element………… Temporal component of the extent of the referring object. └─vertical­Element………… Vertical component of the extent of the referring object.

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­Data­Identification()	Constructs an initially empty data identification.
Default­Data­Identification(Citation citation, Char­Sequence abstracts, Locale language, Topic­Category topic­Category)	Creates a data identification initialized to the specified values.
Default­Data­Identification(Data­Identification object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Data­Identification	cast­Or­Copy(Data­Identification object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Character­Set>	get­Character­Sets()	Deprecated. Replaced by get­Locales­And­Charsets().values().
International­String	get­Environment­Description()	Returns a description of the resource in the producer's processing environment.
Collection<Locale>	get­Languages()	Deprecated. Replaced by get­Locales­And­Charsets().key­Set().
Map<Locale,Charset>	get­Locales­And­Charsets()	Returns the language(s) and character set(s) used within the dataset.
International­String	get­Supplemental­Information()	Any other descriptive information about the resource.
void	set­Character­Sets(Collection<? extends Character­Set> new­Values)	Deprecated. Replaced by putting values in get­Locales­And­Charsets() map.
void	set­Environment­Description(International­String new­Value)	Sets the description of the resource in the producer's processing environment.
void	set­Languages(Collection<? extends Locale> new­Values)	Deprecated. Replaced by putting keys in get­Locales­And­Charsets() map.
void	set­Locales­And­Charsets(Map<? extends Locale, ? extends Charset> new­Values)	Sets the language(s) and character set(s) used within the dataset.
void	set­Supplemental­Information(International­String new­Value)	Sets any other descriptive information about the resource.

Methods inherited from class AbstractIdentification

cast­Or­Copy, get­Abstract, get­Additional­Documentations, get­Aggregation­Info, get­Associated­Resources, get­Citation, get­Credits, get­Descriptive­Keywords, get­Extents, get­Graphic­Overviews, get­Point­Of­Contacts, get­Processing­Level, get­Purpose, get­Resource­Constraints, get­Resource­Formats, get­Resource­Maintenances, get­Resource­Specific­Usages, get­Spatial­Representation­Types, get­Spatial­Resolutions, get­Status, get­Temporal­Resolutions, get­Topic­Categories, set­Abstract, set­Additional­Documentations, set­Aggregation­Info, set­Associated­Resources, set­Citation, set­Credits, set­Descriptive­Keywords, set­Extents, set­Graphic­Overviews, set­Point­Of­Contacts, set­Processing­Level, set­Purpose, set­Resource­Constraints, set­Resource­Formats, set­Resource­Maintenances, set­Resource­Specific­Usages, set­Spatial­Representation­Types, set­Spatial­Resolutions, set­Status, set­Temporal­Resolutions, set­Topic­Categories

Modifier and Type	Method	Description
static Abstract­Identification	cast­Or­Copy(Identification object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Abstract()	Returns a brief narrative summary of the resource(s).
Collection<Citation>	get­Additional­Documentations()	Returns other documentation associated with the resource.
Collection<Aggregate­Information>	get­Aggregation­Info()	Deprecated. As of ISO 19115:2014, replaced by Abstract­Identification.get­Associated­Resources().
Collection<Default­Associated­Resource>	get­Associated­Resources()	Provides associated resource information.
Citation	get­Citation()	Returns the citation for the resource(s).
Collection<String>	get­Credits()	Returns the recognition of those who contributed to the resource(s).
Collection<Keywords>	get­Descriptive­Keywords()	Provides category keywords, their type, and reference source.
Collection<Extent>	get­Extents()	Returns the spatial and temporal extent of the resource.
Collection<Browse­Graphic>	get­Graphic­Overviews()	Provides a graphic that illustrates the resource(s) (should include a legend for the graphic).
Collection<Responsible­Party>	get­Point­Of­Contacts()	Returns the identification of, and means of communication with, person(s) and organizations(s) associated with the resource(s).
Identifier	get­Processing­Level()	Returns code(s) that identifies the level of processing in the producers coding system of a resource.
International­String	get­Purpose()	Returns a summary of the intentions with which the resource(s) was developed.
Collection<Constraints>	get­Resource­Constraints()	Provides information about constraints which apply to the resource(s).
Collection<Format>	get­Resource­Formats()	Provides a description of the format of the resource(s).
Collection<Maintenance­Information>	get­Resource­Maintenances()	Provides information about the frequency of resource updates, and the scope of those updates.
Collection<Usage>	get­Resource­Specific­Usages()	Provides basic information about specific application(s) for which the resource(s) has/have been or is being used by different users.
Collection<Spatial­Representation­Type>	get­Spatial­Representation­Types()	Returns the methods used to spatially represent geographic information.
Collection<Resolution>	get­Spatial­Resolutions()	Returns the factor which provides a general understanding of the density of spatial data in the resource(s).
Collection<Progress>	get­Status()	Returns the status of the resource(s).
Collection<Temporal­Amount>	get­Temporal­Resolutions()	Returns the smallest resolvable temporal period in a resource.
Collection<Topic­Category>	get­Topic­Categories()	Returns the main theme(s) of the resource.
void	set­Abstract(International­String new­Value)	Sets a brief narrative summary of the resource(s).
void	set­Additional­Documentations(Collection<? extends Citation> new­Values)	Sets other documentation associated with the resource.
void	set­Aggregation­Info(Collection<? extends Aggregate­Information> new­Values)	Deprecated. As of ISO 19115:2014, replaced by Abstract­Identification.set­Associated­Resources(Collection).
void	set­Associated­Resources(Collection<? extends Default­Associated­Resource> new­Values)	Sets associated resource information.
void	set­Citation(Citation new­Value)	Sets the citation for the resource(s).
void	set­Credits(Collection<? extends String> new­Values)	Sets the recognition of those who contributed to the resource(s).
void	set­Descriptive­Keywords(Collection<? extends Keywords> new­Values)	Sets category keywords, their type, and reference source.
void	set­Extents(Collection<? extends Extent> new­Values)	Sets the spatial and temporal extent of the resource.
void	set­Graphic­Overviews(Collection<? extends Browse­Graphic> new­Values)	Sets a graphic that illustrates the resource(s).
void	set­Point­Of­Contacts(Collection<? extends Responsible­Party> new­Values)	Sets the means of communication with persons(s) and organizations(s) associated with the resource(s).
void	set­Processing­Level(Identifier new­Value)	Sets code that identifies the level of processing in the producers coding system of a resource.
void	set­Purpose(International­String new­Value)	Sets a summary of the intentions with which the resource(s) was developed.
void	set­Resource­Constraints(Collection<? extends Constraints> new­Values)	Sets information about constraints which apply to the resource(s).
void	set­Resource­Formats(Collection<? extends Format> new­Values)	Sets a description of the format of the resource(s).
void	set­Resource­Maintenances(Collection<? extends Maintenance­Information> new­Values)	Sets information about the frequency of resource updates, and the scope of those updates.
void	set­Resource­Specific­Usages(Collection<? extends Usage> new­Values)	Sets basic information about specific application(s).
void	set­Spatial­Representation­Types(Collection<? extends Spatial­Representation­Type> new­Values)	Sets the method used to spatially represent geographic information.
void	set­Spatial­Resolutions(Collection<? extends Resolution> new­Values)	Sets the factor which provides a general understanding of the density of spatial data in the resource(s).
void	set­Status(Collection<? extends Progress> new­Values)	Sets the status of the resource(s).
void	set­Temporal­Resolutions(Collection<? extends Temporal­Amount> new­Values)	Sets the smallest resolvable temporal period in a resource.
void	set­Topic­Categories(Collection<? extends Topic­Category> new­Values)	Sets the main theme(s) of the resource.

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

Methods inherited from interface DataIdentification

get­Extents, get­Spatial­Representation­Types, get­Spatial­Resolutions, get­Topic­Categories

Modifier and Type	Method	Description
Collection<? extends Extent>	get­Extents()	Additional extent information including the bounding polygon, vertical, and temporal extent of the dataset.
Collection<Spatial­Representation­Type>	get­Spatial­Representation­Types()	Method used to spatially represent geographic information.
Collection<? extends Resolution>	get­Spatial­Resolutions()	Factor which provides a general understanding of the density of spatial data in the dataset.
Collection<Topic­Category>	get­Topic­Categories()	Main theme(s) of the dataset.

Constructor Details

DefaultDataIdentification

public DefaultDataIdentification()

Constructs an initially empty data identification.

DefaultDataIdentification

public DefaultDataIdentification(Citation citation,
 CharSequence abstracts,
 Locale language,
 TopicCategory topicCategory)

Creates a data identification initialized to the specified values.

Parameters:

citation - the citation data for the resource(s), or null if none.

abstracts - a brief narrative summary of the content of the resource(s), or null if none.

language - the language used within the dataset, or null if none.

topic­Category - the main theme of the dataset, or null if none.

DefaultDataIdentification

public DefaultDataIdentification(DataIdentification 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(Data­Identification)

Method Details

castOrCopy

public static DefaultDataIdentification castOrCopy(DataIdentification 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­Data­Identification, then it is returned unchanged.
• Otherwise a new Default­Data­Identification 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.

getLocalesAndCharsets

@UML(identifier="defaultLocale+otherLocale",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public Map<Locale,Charset> getLocalesAndCharsets()

Returns the language(s) and character set(s) used within the dataset. The first element in iteration order is the default language. All other elements, if any, are alternate language(s) used within the resource.

Returns:

language(s) and character set(s) used within the dataset.

Since:

1.0

setLocalesAndCharsets

public void setLocalesAndCharsets(Map<? extends Locale, ? extends Charset> newValues)

Sets the language(s) and character set(s) used within the dataset. The first element in iteration order should be the default language. All other elements, if any, are alternate language(s) used within the resource.

Parameters:

new­Values - the new language(s) and character set(s) used within the dataset.

Since:

1.0

getLanguages

@Deprecated(since="1.0")
public Collection<Locale> getLanguages()

Deprecated.

Replaced by get­Locales­And­Charsets().key­Set().

Returns the language(s) used within the resource. The first element in iteration order shall be the default language. All other elements, if any, are alternate language(s) used within the resource.

The language string representations should use ISO 639-2 language code as returned by Locale.get­ISO3Language().

Specified by:

get­Languages in interface Data­Identification

Returns:

language(s) used.

setLanguages

@Deprecated(since="1.0")
public void setLanguages(Collection<? extends Locale> newValues)

Deprecated.

Replaced by putting keys in get­Locales­And­Charsets() map.

Sets the language(s) used within the resource.

Parameters:

new­Values - the new languages.

getCharacterSets

@Deprecated(since="1.0")
public Collection<CharacterSet> getCharacterSets()

Deprecated.

Replaced by get­Locales­And­Charsets().values().

Returns the character coding standard used for the dataset.

Upcoming API change — JDK integration
The element type may change to the Charset class in GeoAPI 4.0.

Specified by:

get­Character­Sets in interface Data­Identification

Returns:

character coding standard(s) used.

setCharacterSets

@Deprecated(since="1.0")
public void setCharacterSets(Collection<? extends CharacterSet> newValues)

Deprecated.

Replaced by putting values in get­Locales­And­Charsets() map.

Sets the character coding standard used for the dataset.

Upcoming API change — JDK integration
The element type may change to the Charset class in GeoAPI 4.0.

Parameters:

new­Values - the new character sets.

getEnvironmentDescription

public InternationalString getEnvironmentDescription()

Returns a description of the resource in the producer's processing environment. This includes items such as the software, the computer operating system, file name, and the dataset size.

Specified by:

get­Environment­Description in interface Data­Identification

Returns:

description of the resource in the producer's processing environment, or null.

setEnvironmentDescription

public void setEnvironmentDescription(InternationalString newValue)

Sets the description of the resource in the producer's processing environment.

Parameters:

new­Value - the new environment description.

getSupplementalInformation

public InternationalString getSupplementalInformation()

Any other descriptive information about the resource.

Specified by:

get­Supplemental­Information in interface Data­Identification

Returns:

other descriptive information, or null.

setSupplementalInformation

public void setSupplementalInformation(InternationalString newValue)

Sets any other descriptive information about the resource.

Parameters:

new­Value - the new supplemental information.