Class DefaultMaintenanceInformation

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultMaintenanceInformation

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Maintenance­Information

public class DefaultMaintenanceInformation
extends ISOMetadata
implements MaintenanceInformation

Information about the scope and frequency of updating. The following property is mandatory in a well-formed metadata according ISO 19115:

MD_Maintenance­Information └─maintenance­And­Update­Frequency…… Frequency with which changes and additions are made to the resource.

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­Maintenance­Information()	Creates a an initially empty maintenance information.
Default­Maintenance­Information(Maintenance­Frequency maintenance­And­Update­Frequency)	Creates a maintenance information.
Default­Maintenance­Information(Maintenance­Information object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Maintenance­Information	cast­Or­Copy(Maintenance­Information object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Responsible­Party>	get­Contacts()	Returns identification of, and means of communicating with, person(s) and organization(s) with responsibility for maintaining the resource.
Date	get­Date­Of­Next­Update()	Deprecated. As of ISO 19115:2014, replaced by get­Maintenance­Dates() in order to enable inclusion of a Date­Type to describe the type of the date.
Maintenance­Frequency	get­Maintenance­And­Update­Frequency()	Returns the frequency with which changes and additions are made to the resource after the initial resource is completed.
Collection<Citation­Date>	get­Maintenance­Dates()	Return the date information associated with maintenance of resource.
Collection<International­String>	get­Maintenance­Notes()	Returns information regarding specific requirements for maintaining the resource.
Collection<Scope>	get­Maintenance­Scopes()	Return the types of resource and / or extents to which the maintenance information applies.
final Collection<Scope­Description>	get­Update­Scope­Descriptions()	Deprecated. As of ISO 19115:2014, get­Update­Scopes() and get­Update­Scope­Descriptions() were combined into get­Maintenance­Scopes() in order to allow specifying a scope that includes a spatial and temporal extent.
final Collection<Scope­Code>	get­Update­Scopes()	Deprecated. As of ISO 19115:2014, get­Update­Scopes() and get­Update­Scope­Descriptions() were combined into get­Maintenance­Scopes() in order to allow specifying a scope that includes a spatial and temporal extent.
Period­Duration	get­User­Defined­Maintenance­Frequency()	Returns the maintenance period other than those defined.
void	set­Contacts(Collection<? extends Responsible­Party> new­Values)	Sets identification of, and means of communicating with, person(s) and organization(s) with responsibility for maintaining the resource.
void	set­Date­Of­Next­Update(Date new­Value)	Deprecated.
void	set­Maintenance­And­Update­Frequency(Maintenance­Frequency new­Value)	Sets the frequency with which changes and additions are made to the resource after the initial resource is completed.
void	set­Maintenance­Dates(Collection<? extends Citation­Date> new­Values)	Sets the date information associated with maintenance of resource.
void	set­Maintenance­Notes(Collection<? extends International­String> new­Values)	Sets information regarding specific requirements for maintaining the resource.
void	set­Maintenance­Scopes(Collection<? extends Scope> new­Values)	Sets the types of resource and / or extents to which the maintenance information applies.
void	set­Update­Scope­Descriptions(Collection<? extends Scope­Description> new­Values)	Deprecated. As of ISO 19115:2014, replaced by set­Maintenance­Scopes(Collection).
void	set­Update­Scopes(Collection<? extends Scope­Code> new­Values)	Deprecated. As of ISO 19115:2014, replaced by set­Maintenance­Scopes(Collection).
void	set­User­Defined­Maintenance­Frequency(Period­Duration new­Value)	Sets the maintenance period other than those defined.

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

DefaultMaintenanceInformation

public DefaultMaintenanceInformation()

Creates a an initially empty maintenance information.

DefaultMaintenanceInformation

public DefaultMaintenanceInformation(MaintenanceFrequency maintenanceAndUpdateFrequency)

Creates a maintenance information.

Parameters:

maintenance­And­Update­Frequency - the frequency with which changes and additions are made to the resource after the initial resource is completed, or null if none.

DefaultMaintenanceInformation

public DefaultMaintenanceInformation(MaintenanceInformation 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(Maintenance­Information)

Method Details

castOrCopy

public static DefaultMaintenanceInformation castOrCopy(MaintenanceInformation 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­Maintenance­Information, then it is returned unchanged.
• Otherwise a new Default­Maintenance­Information 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.

getMaintenanceAndUpdateFrequency

public MaintenanceFrequency getMaintenanceAndUpdateFrequency()

Returns the frequency with which changes and additions are made to the resource after the initial resource is completed.

Specified by:

get­Maintenance­And­Update­Frequency in interface Maintenance­Information

Returns:

frequency with which changes and additions are made to the resource, or null.

setMaintenanceAndUpdateFrequency

public void setMaintenanceAndUpdateFrequency(MaintenanceFrequency newValue)

Sets the frequency with which changes and additions are made to the resource after the initial resource is completed.

Parameters:

new­Value - the new maintenance frequency.

getMaintenanceDates

@UML(identifier="maintenanceDate",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<CitationDate> getMaintenanceDates()

Return the date information associated with maintenance of resource.

Returns:

date information associated with maintenance of resource.

Since:

0.5

setMaintenanceDates

public void setMaintenanceDates(Collection<? extends CitationDate> newValues)

Sets the date information associated with maintenance of resource.

Parameters:

new­Values - the new date information associated with maintenance of resource.

Since:

0.5

getDateOfNextUpdate

@Deprecated(since="1.0")
public Date getDateOfNextUpdate()

Deprecated.

As of ISO 19115:2014, replaced by get­Maintenance­Dates() in order to enable inclusion of a Date­Type to describe the type of the date. The associated date type is Date­Type.value­Of("NEXT_UPDATE").

Returns the scheduled revision date for resource. This method fetches the value from the maintenance dates.

Specified by:

get­Date­Of­Next­Update in interface Maintenance­Information

Returns:

scheduled revision date, or null.

setDateOfNextUpdate

@Deprecated(since="1.0")
public void setDateOfNextUpdate(Date newValue)

Deprecated.

Sets the scheduled revision date for resource. This method stores the value in the maintenance dates.

Parameters:

new­Value - the new date of next update.

getUserDefinedMaintenanceFrequency

public PeriodDuration getUserDefinedMaintenanceFrequency()

Returns the maintenance period other than those defined.

Upcoming API change
The return type may be changed to Temporal­Amount in Apache SIS 2.0. This change depend on a corresponding change in GeoAPI interfaces.

Specified by:

get­User­Defined­Maintenance­Frequency in interface Maintenance­Information

Returns:

the maintenance period, or null.

setUserDefinedMaintenanceFrequency

public void setUserDefinedMaintenanceFrequency(PeriodDuration newValue)

Sets the maintenance period other than those defined.

Upcoming API change
The parameter type may be changed to Temporal­Amount in Apache SIS 2.0. This change depend on a corresponding change in GeoAPI interfaces.

Parameters:

new­Value - the new user defined maintenance frequency.

getMaintenanceScopes

@UML(identifier="maintenanceScope",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Scope> getMaintenanceScopes()

Return the types of resource and / or extents to which the maintenance information applies.

Returns:

type of resource and / or extent to which the maintenance information applies.

Since:

0.5

setMaintenanceScopes

public void setMaintenanceScopes(Collection<? extends Scope> newValues)

Sets the types of resource and / or extents to which the maintenance information applies.

Parameters:

new­Values - the types of resource and / or extents to which the maintenance information applies.

Since:

0.5

getUpdateScopes

@Deprecated(since="1.0")
public final Collection<ScopeCode> getUpdateScopes()

Deprecated.

As of ISO 19115:2014, get­Update­Scopes() and get­Update­Scope­Descriptions() were combined into get­Maintenance­Scopes() in order to allow specifying a scope that includes a spatial and temporal extent.

Returns the scope of data to which maintenance is applied. This method fetches the values from the maintenance scopes.

Specified by:

get­Update­Scopes in interface Maintenance­Information

Returns:

scope of data to which maintenance is applied.

setUpdateScopes

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

Deprecated.

As of ISO 19115:2014, replaced by set­Maintenance­Scopes(Collection).

Sets the scope of data to which maintenance is applied. This method stores the values in the maintenance scopes.

Parameters:

new­Values - the new update scopes.

getUpdateScopeDescriptions

@Deprecated(since="1.0")
public final Collection<ScopeDescription> getUpdateScopeDescriptions()

Deprecated.

As of ISO 19115:2014, get­Update­Scopes() and get­Update­Scope­Descriptions() were combined into get­Maintenance­Scopes() in order to allow specifying a scope that includes a spatial and temporal extent.

Returns additional information about the range or extent of the resource. This method fetches the values from the maintenance scopes.

Specified by:

get­Update­Scope­Descriptions in interface Maintenance­Information

Returns:

additional information about the range or extent of the resource.

setUpdateScopeDescriptions

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

Deprecated.

As of ISO 19115:2014, replaced by set­Maintenance­Scopes(Collection).

Sets additional information about the range or extent of the resource. This method stores the values in the maintenance scopes.

Parameters:

new­Values - the new update scope descriptions.

getMaintenanceNotes

public Collection<InternationalString> getMaintenanceNotes()

Returns information regarding specific requirements for maintaining the resource.

Specified by:

get­Maintenance­Notes in interface Maintenance­Information

Returns:

information regarding specific requirements for maintaining the resource.

setMaintenanceNotes

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

Sets information regarding specific requirements for maintaining the resource.

Parameters:

new­Values - the new maintenance notes.

getContacts

public Collection<ResponsibleParty> getContacts()

Returns identification of, and means of communicating with, person(s) and organization(s) with responsibility for maintaining the resource.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Specified by:

get­Contacts in interface Maintenance­Information

Returns:

means of communicating with person(s) and organization(s) with responsibility for maintaining the resource.

setContacts

public void setContacts(Collection<? extends ResponsibleParty> newValues)

Sets identification of, and means of communicating with, person(s) and organization(s) with responsibility for maintaining the resource.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Parameters:

new­Values - the new identification of person(s) and organization(s) with responsibility for maintaining the resource.