Class DefaultAssociatedResource

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultAssociatedResource

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

Direct Known Subclasses:

Default­Aggregate­Information

@TitleProperty(name="name")
@UML(identifier="MD_AssociatedResource",
     specification=ISO_19115)
public class DefaultAssociatedResource
extends ISOMetadata

Associated resource information. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_Associated­Resource ├─association­Type………… Type of relation between the resources. ├─metadata­Reference…… Reference to the metadata of the associated resource. │ ├─title………………………… Name by which the cited resource is known. │ └─date…………………………… Reference date for the cited resource. └─name……………………………………… Citation information about the associated resource.

According ISO 19115, at least one of name and metadata reference shall be provided.

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­Associated­Resource()	Constructs an initially empty associated resource.
Default­Associated­Resource(Citation name, Association­Type association­Type)	Constructs an associated resource initialized to the specified values.

Method Summary

Modifier and Type	Method	Description
Association­Type	get­Association­Type()	Returns the type of relation between the resources.
Initiative­Type	get­Initiative­Type()	Returns the type of initiative under which the associated resource was produced, or null if none.
Citation	get­Metadata­Reference()	Return a reference to the metadata of the associated resource, or null if none.
Citation	get­Name()	Returns citation information about the associated resource, or null if none.
void	set­Association­Type(Association­Type new­Value)	Sets the type of relation between the resources.
void	set­Initiative­Type(Initiative­Type new­Value)	Sets a new type of initiative under which the associated resource was produced.
void	set­Metadata­Reference(Citation new­Value)	Sets the reference to the metadata of the associated resource.
void	set­Name(Citation new­Value)	Sets citation information about the associated 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

Constructor Details

DefaultAssociatedResource

public DefaultAssociatedResource()

Constructs an initially empty associated resource.

DefaultAssociatedResource

public DefaultAssociatedResource(Citation name,
 AssociationType associationType)

Constructs an associated resource initialized to the specified values.

Parameters:

name - citation information about the associated resource.

association­Type - type of relation between the resources.

Method Details

getName

@UML(identifier="name",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public Citation getName()

Returns citation information about the associated resource, or null if none.

Returns:

Citation information about the associated resource, or null if none.

setName

public void setName(Citation newValue)

Sets citation information about the associated resource.

Parameters:

new­Value - the new citation information, or null.

getAssociationType

@UML(identifier="associationType",
     obligation=MANDATORY,
     specification=ISO_19115)
public AssociationType getAssociationType()

Returns the type of relation between the resources.

Returns:

type of relation between the resources.

setAssociationType

public void setAssociationType(AssociationType newValue)

Sets the type of relation between the resources.

Parameters:

new­Value - the new type of relation.

getInitiativeType

@UML(identifier="initiativeType",
     obligation=OPTIONAL,
     specification=ISO_19115)
public InitiativeType getInitiativeType()

Returns the type of initiative under which the associated resource was produced, or null if none.

Returns:

the type of initiative under which the associated resource was produced, or null if none.

setInitiativeType

public void setInitiativeType(InitiativeType newValue)

Sets a new type of initiative under which the associated resource was produced.

Parameters:

new­Value - the new type of initiative.

getMetadataReference

@UML(identifier="metadataReference",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public Citation getMetadataReference()

Return a reference to the metadata of the associated resource, or null if none.

Returns:

reference to the metadata of the associated resource, or null if none.

setMetadataReference

public void setMetadataReference(Citation newValue)

Sets the reference to the metadata of the associated resource.

Parameters:

new­Value - the new reference to the metadata.