Class DefaultConstraints

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultConstraints

All Implemented Interfaces:

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

Direct Known Subclasses:

Default­Legal­Constraints, Default­Security­Constraints

public class DefaultConstraints
extends ISOMetadata
implements Constraints

Restrictions on the access and use of a resource or metadata.

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­Constraints()	Constructs an initially empty constraints.
Default­Constraints(Char­Sequence use­Limitation)	Constructs a new constraints with the given use limitation.
Default­Constraints(Constraints object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Constraints	cast­Or­Copy(Constraints object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Scope	get­Constraint­Application­Scope()	Returns the spatial and / or temporal extents and or levels of the application of the constraints restrictions.
Collection<Browse­Graphic>	get­Graphics()	Returns the graphics / symbols indicating the constraint.
Collection<Citation>	get­References()	Returns citations for the limitation of constraint.
Default­Releasability	get­Releasability()	Returns information concerning the parties to whom the resource can or cannot be released.
Collection<Default­Responsibility>	get­Responsible­Parties()	Returns the parties responsible for the resource constraints.
Collection<International­String>	get­Use­Limitations()	Returns the limitation affecting the fitness for use of the resource.
void	set­Constraint­Application­Scope(Scope new­Value)	Sets the spatial and / or temporal extents and or levels of the application of the constraints restrictions.
void	set­Graphics(Collection<? extends Browse­Graphic> new­Values)	Sets the new graphics / symbols indicating the constraint.
void	set­References(Collection<? extends Citation> new­Values)	Sets the citations for the limitation of constraint.
void	set­Releasability(Default­Releasability new­Value)	Sets the information concerning the parties to whom the resource.
void	set­Responsible­Parties(Collection<? extends Default­Responsibility> new­Values)	Sets the parties responsible for the resource constraints.
void	set­Use­Limitations(Collection<? extends International­String> new­Values)	Sets the limitation affecting the fitness for use 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

Constructor Details

DefaultConstraints

public DefaultConstraints()

Constructs an initially empty constraints.

DefaultConstraints

public DefaultConstraints(CharSequence useLimitation)

Constructs a new constraints with the given use limitation.

Parameters:

use­Limitation - the use limitation, or null if none.

DefaultConstraints

public DefaultConstraints(Constraints 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(Constraints)

Method Details

castOrCopy

public static DefaultConstraints castOrCopy(Constraints 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 an instance of Legal­Constraints or Security­Constraints, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then the cast­Or­Copy(…) method to be used is unspecified.
• Otherwise if the given object is already an instance of Default­Constraints, then it is returned unchanged.
• Otherwise a new Default­Constraints 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.

getUseLimitations

public Collection<InternationalString> getUseLimitations()

Returns the limitation affecting the fitness for use of the resource. Example: not to be used for navigation.

Specified by:

get­Use­Limitations in interface Constraints

Returns:

limitation affecting the fitness for use of the resource.

setUseLimitations

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

Sets the limitation affecting the fitness for use of the resource. Example: not to be used for navigation.

Parameters:

new­Values - the new use limitations.

getConstraintApplicationScope

@UML(identifier="constraintApplicationScope",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Scope getConstraintApplicationScope()

Returns the spatial and / or temporal extents and or levels of the application of the constraints restrictions.

Returns:

spatial and / or temporal extents.

Since:

0.5

setConstraintApplicationScope

public void setConstraintApplicationScope(Scope newValue)

Sets the spatial and / or temporal extents and or levels of the application of the constraints restrictions.

Parameters:

new­Value - the new spatial and / or temporal extents.

Since:

0.5

getGraphics

@UML(identifier="graphic",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<BrowseGraphic> getGraphics()

Returns the graphics / symbols indicating the constraint.

Returns:

the graphics / symbols indicating the constraint.

Since:

0.5

setGraphics

public void setGraphics(Collection<? extends BrowseGraphic> newValues)

Sets the new graphics / symbols indicating the constraint.

Parameters:

new­Values - the new graphics / symbols indicating the constraint.

Since:

0.5

getReferences

@UML(identifier="reference",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Citation> getReferences()

Returns citations for the limitation of constraint. Example: "copyright statement, license agreement, etc."

Returns:

citations for the limitation of constraint.

Since:

0.5

setReferences

public void setReferences(Collection<? extends Citation> newValues)

Sets the citations for the limitation of constraint.

Parameters:

new­Values - the new citation for the limitation of constraint.

Since:

0.5

getReleasability

@UML(identifier="releasability",
     obligation=OPTIONAL,
     specification=ISO_19115)
public DefaultReleasability getReleasability()

Returns information concerning the parties to whom the resource can or cannot be released.

Upcoming API change — generalization
The return type will be changed to the Releasability interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Returns:

information concerning the parties to whom the resource can or cannot be released, or null if none.

Since:

0.5

setReleasability

public void setReleasability(DefaultReleasability newValue)

Sets the information concerning the parties to whom the resource.

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

Parameters:

new­Value - the new information concerning the parties to whom the resource can or cannot be released.

Since:

0.5

getResponsibleParties

@UML(identifier="responsibleParty",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<DefaultResponsibility> getResponsibleParties()

Returns the parties responsible for the resource constraints.

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

Returns:

parties responsible for the resource constraints.

Since:

0.5

setResponsibleParties

public void setResponsibleParties(Collection<? extends DefaultResponsibility> newValues)

Sets the parties responsible for the resource constraints.

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

Parameters:

new­Values - the new parties responsible for the resource constraints.

Since:

0.5