Class SpatialUnitMetadata

java.lang.Object

net.okapia.osid.jamocha.metadata.spi.AbstractMetadata

net.okapia.osid.jamocha.metadata.spi.AbstractSpatialUnitMetadata

net.okapia.osid.jamocha.metadata.SpatialUnitMetadata

All Implemented Interfaces:

Metadata

public final class SpatialUnitMetadata
extends AbstractSpatialUnitMetadata
implements Metadata

Defines a spatial unit Metadata.

Constructor Summary

Constructors

Constructor	Description
SpatialUnitMetadata(Id elementId)	Constructs a new single unlinked SpatialUnitMetadata.
SpatialUnitMetadata(Id elementId, boolean isArray)	Constructs a new unlinked SpatialUnitMetadata.
SpatialUnitMetadata(Id elementId, boolean isArray, boolean isLinked)	Constructs a new SpatialUnitMetadata.

Method Summary

Modifier and Type	Method	Description
void	addDefaultSpatialUnitValue(SpatialUnit value)	Adds a default spatial unit value.
void	addDefaultSpatialUnitValues(Collection<SpatialUnit> values)	Adds a collection of default spatial unit values.
void	addExistingSpatialUnitValue(SpatialUnit value)	Adds a existing spatial unit value.
void	addExistingSpatialUnitValues(Collection<SpatialUnit> values)	Adds a collection of existing spatial unit values.
void	addSpatialUnitRecordType(Type spatialUnitRecordType)	Add support for a spatial unit record type.
void	addToSpatialUnitSet(Collection<SpatialUnit> values)	Adds a collection of values to the spatial unit set.
void	addToSpatialUnitSet(SpatialUnit value)	Adds a value to the spatial unit set.
void	clearDefaultSpatialUnitValues()	Clears the default spatial unit values.
void	clearExistingSpatialUnitValues()	Clears the existing spatial unit values.
void	clearSpatialUnitSet()	Clears the spatial unit set.
void	removeDefaultSpatialUnitValue(SpatialUnit value)	Removes a default spatial unit value.
void	removeExistingSpatialUnitValue(SpatialUnit value)	Removes a existing spatial unit value.
void	removeFromSpatialUnitSet(SpatialUnit value)	Removes a value from the spatial unit set.
void	setDefaultSpatialUnitValues(Collection<SpatialUnit> values)	Sets the default spatial unit set.
void	setExistingSpatialUnitValues(Collection<SpatialUnit> values)	Sets the existing spatial unit set.
void	setInstructions(DisplayText instructions)	Sets the instructions.
void	setLabel(DisplayText label)	Sets the element label.
void	setReadOnly(boolean readonly)	Sets the read only flag.
void	setRequired(boolean required)	Sets the required flag.
void	setSpatialUnitSet(Collection<SpatialUnit> values)	Sets the spatial unit set.
void	setUnits(DisplayText units)	Sets the units.
void	setValueExists(boolean exists)	Sets the has value flag.

Methods inherited from class AbstractSpatialUnitMetadata

getDefaultSpatialUnitValues, getExistingSpatialUnitValues, getSpatialUnitRecordTypes, getSpatialUnitSet, supportsSpatialUnitRecordType

Modifier and Type	Method	Description
SpatialUnit[]	getDefaultSpatialUnitValues()	Deprecated. spatial units are deprecated in the OSID specification
SpatialUnit[]	getExistingSpatialUnitValues()	Deprecated. spatial units are deprecated in the OSID specification
Type[]	getSpatialUnitRecordTypes()	Deprecated. spatial units are deprecated in the OSID specification
SpatialUnit[]	getSpatialUnitSet()	Deprecated. spatial units are deprecated in the OSID specification
boolean	supportsSpatialUnitRecordType(Type spatialUnitRecordType)	Deprecated. spatial units are deprecated in the OSID specification

Methods inherited from class AbstractMetadata

getAxesForCoordinateType, getAxesForHeadingType, getCalendarTypes, getCardinalSet, getCoordinateSet, getCoordinateTypes, getCurrencySet, getCurrencyTypes, getDateTimeResolution, getDateTimeSet, getDecimalScale, getDecimalSet, getDefaultCardinalValues, getDefaultCoordinateValues, getDefaultCurrencyValues, getDefaultDateTimeValues, getDefaultDecimalValues, getDefaultDistanceValues, getDefaultDurationValues, getDefaultHeadingValues, getDefaultIdValues, getDefaultIntegerValues, getDefaultObjectValues, getDefaultSpeedValues, getDefaultStringValues, getDefaultTimeValues, getDefaultTypeValues, getDefaultVersionValues, getDistanceResolution, getDistanceSet, getDurationSet, getElementId, getElementLabel, getExistingCardinalValues, getExistingCoordinateValues, getExistingCurrencyValues, getExistingDateTimeValues, getExistingDecimalValues, getExistingDistanceValues, getExistingDurationValues, getExistingHeadingValues, getExistingIdValues, getExistingIntegerValues, getExistingObjectValues, getExistingSpeedValues, getExistingStringValues, getExistingTimeValues, getExistingTypeValues, getExistingVersionValues, getHeadingSet, getHeadingTypes, getIdSet, getInstructions, getIntegerSet, getMaximumCardinal, getMaximumCoordinateValues, getMaximumCurrency, getMaximumDateTime, getMaximumDecimal, getMaximumDistance, getMaximumDuration, getMaximumElements, getMaximumHeadingValues, getMaximumInteger, getMaximumSpeed, getMaximumStringLength, getMaximumTime, getMaximumVersion, getMinimumCardinal, getMinimumCoordinateValues, getMinimumCurrency, getMinimumDateTime, getMinimumDecimal, getMinimumDistance, getMinimumDuration, getMinimumElements, getMinimumHeadingValues, getMinimumInteger, getMinimumSpeed, getMinimumStringLength, getMinimumTime, getMinimumVersion, getObjectSet, getObjectTypes, getSpeedSet, getStringExpression, getStringFormatTypes, getStringMatchTypes, getStringSet, getSyntax, getTimeSet, getTimeTypes, getTypeSet, getUnits, getVersionSet, getVersionTypes, hasValue, isArray, isLinked, isReadOnly, isRequired, isValueKnown, setNumberElements, setValueKnown, supportsCalendarType, supportsCoordinateType, supportsCurrencyType, supportsHeadingType, supportsObjectType, supportsStringMatchType, supportsTimeType, supportsVersionType

Modifier and Type	Method	Description
long	getAxesForCoordinateType(Type coordinateType)	Gets the number of axes for a given supported coordinate type.
long	getAxesForHeadingType(Type headingType)	Gets the number of axes for a given supported heading type.
Type[]	getCalendarTypes()	Gets the set of acceptable calendar types.
long[]	getCardinalSet()	Gets the set of acceptable cardinal values.
Coordinate[]	getCoordinateSet()	Gets the set of acceptable coordinate values.
Type[]	getCoordinateTypes()	Gets the set of acceptable coordinate types.
Currency[]	getCurrencySet()	Gets the set of acceptable currency values.
Type[]	getCurrencyTypes()	Gets the set of acceptable currency types.
DateTimeResolution	getDateTimeResolution()	Gets the smallest resolution of the date time value.
DateTime[]	getDateTimeSet()	Gets the set of acceptable date time values.
long	getDecimalScale()	Gets the number of digits to the right of the decimal point.
BigDecimal[]	getDecimalSet()	Gets the set of acceptable decimal values.
long[]	getDefaultCardinalValues()	Gets the default cardinal values.
Coordinate[]	getDefaultCoordinateValues()	Gets the default coordinate values.
Currency[]	getDefaultCurrencyValues()	Gets the default currency values.
DateTime[]	getDefaultDateTimeValues()	Gets the default date time values.
BigDecimal[]	getDefaultDecimalValues()	Gets the default decimal values.
Distance[]	getDefaultDistanceValues()	Gets the default distance values.
Duration[]	getDefaultDurationValues()	Gets the default duration values.
Heading[]	getDefaultHeadingValues()	Gets the default heading values.
Id[]	getDefaultIdValues()	Gets the default Id values.
long[]	getDefaultIntegerValues()	Gets the default integer values.
Object[]	getDefaultObjectValues()	Gets the default object values.
Speed[]	getDefaultSpeedValues()	Gets the default speed values.
String[]	getDefaultStringValues()	Gets the default string values.
Time[]	getDefaultTimeValues()	Gets the default time values.
Type[]	getDefaultTypeValues()	Gets the default type values.
Version[]	getDefaultVersionValues()	Gets the default version values.
DistanceResolution	getDistanceResolution()	Gets the smallest resolution of the distance value.
Distance[]	getDistanceSet()	Gets the set of acceptable distance values.
Duration[]	getDurationSet()	Gets the set of acceptable duration values.
final Id	getElementId()	Gets a unique Id for the data element.
final DisplayText	getElementLabel()	Gets a display label for the data element.
long[]	getExistingCardinalValues()	Gets the existing cardinal values.
Coordinate[]	getExistingCoordinateValues()	Gets the existing coordinate values.
Currency[]	getExistingCurrencyValues()	Gets the existing currency values.
DateTime[]	getExistingDateTimeValues()	Gets the existing date time values.
BigDecimal[]	getExistingDecimalValues()	Gets the existing decimal values.
Distance[]	getExistingDistanceValues()	Gets the existing distance values.
Duration[]	getExistingDurationValues()	Gets the existing duration values.
Heading[]	getExistingHeadingValues()	Gets the existing heading values.
Id[]	getExistingIdValues()	Gets the existing Id values.
long[]	getExistingIntegerValues()	Gets the existing integer values.
Object[]	getExistingObjectValues()	Gets the existing object values.
Speed[]	getExistingSpeedValues()	Gets the existing speed values.
String[]	getExistingStringValues()	Gets the existing string values.
Time[]	getExistingTimeValues()	Gets the existing time values.
Type[]	getExistingTypeValues()	Gets the existing type values.
Version[]	getExistingVersionValues()	Gets the existing version values.
Heading[]	getHeadingSet()	Gets the set of acceptable heading values.
Type[]	getHeadingTypes()	Gets the set of acceptable heading types.
Id[]	getIdSet()	Gets the set of acceptable Ids.
final DisplayText	getInstructions()	Gets instructions for updating this data.
long[]	getIntegerSet()	Gets the set of acceptable integer values.
long	getMaximumCardinal()	Gets the maximum cardinal value.
BigDecimal[]	getMaximumCoordinateValues(Type coordinateType)	Gets the maximum coordinate values given supported coordinate type.
Currency	getMaximumCurrency()	Gets the maximum currency value.
DateTime	getMaximumDateTime()	Gets the maximum date time value.
BigDecimal	getMaximumDecimal()	Gets the maximum decimal value.
Distance	getMaximumDistance()	Gets the maximum distance value.
Duration	getMaximumDuration()	Gets the maximum duration.
final long	getMaximumElements()	In the case where an array or list of elements is specified in an OsidForm, this specifies the maximum number of elements that must be included.
BigDecimal[]	getMaximumHeadingValues(Type headingType)	Gets the maximum heading values given supported heading type.
long	getMaximumInteger()	Gets the maximum integer value.
Speed	getMaximumSpeed()	Gets the maximum speed value.
long	getMaximumStringLength()	Gets the maximum string length.
Time	getMaximumTime()	Gets the maximum time value.
Version	getMaximumVersion()	Gets the maximum acceptable Version.
long	getMinimumCardinal()	Gets the minimum cardinal value.
BigDecimal[]	getMinimumCoordinateValues(Type coordinateType)	Gets the minimum coordinate values given supported coordinate type.
Currency	getMinimumCurrency()	Gets the minimum currency value.
DateTime	getMinimumDateTime()	Gets the minimum date time value.
BigDecimal	getMinimumDecimal()	Gets the minimum decimal value.
Distance	getMinimumDistance()	Gets the minimum distance value.
Duration	getMinimumDuration()	Gets the minimum duration.
final long	getMinimumElements()	In the case where an array or list of elements is specified in an OsidForm, this specifies the minimum number of elements that must be included.
BigDecimal[]	getMinimumHeadingValues(Type headingType)	Gets the minimum heading values given supported heading type.
long	getMinimumInteger()	Gets the minimum integer value.
Speed	getMinimumSpeed()	Gets the minimum speed value.
long	getMinimumStringLength()	Gets the minimum string length.
Time	getMinimumTime()	Gets the minimum time value.
Version	getMinimumVersion()	Gets the minumim acceptable Version.
Object[]	getObjectSet()	Gets the set of acceptable object values.
Type[]	getObjectTypes()	Gets the set of acceptable Types for an arbitrary object.
Speed[]	getSpeedSet()	Gets the set of acceptable speed values.
String	getStringExpression(Type stringMatchType)	Gets the regular expression of an acceptable string for the given string match type.
Type[]	getStringFormatTypes()	Gets the set of valid string formats.
Type[]	getStringMatchTypes()	Gets the set of valid string match types for use in validating a string.
String[]	getStringSet()	Gets the set of acceptable string values.
final Syntax	getSyntax()	Gets the syntax of this data.
Time[]	getTimeSet()	Gets the set of acceptable time values.
Type[]	getTimeTypes()	Gets the set of acceptable time types.
Type[]	getTypeSet()	Gets the set of acceptable Types.
final DisplayText	getUnits()	Gets the units of this data for display purposes ('lbs', 'gills', 'furlongs').
Version[]	getVersionSet()	Gets the set of acceptable Versions.
Type[]	getVersionTypes()	Gets the set of acceptable version types.
final boolean	hasValue()	Tests if this data element has a set non-default value.
final boolean	isArray()	Tests if this data element is an array.
final boolean	isLinked()	Tests if this data element is linked to other data in the object.
final boolean	isReadOnly()	Tests if this data can be updated.
final boolean	isRequired()	Tests if this data element is required for creating new objects.
boolean	isValueKnown()	Tests if an existing value is known for this data element.
protected void	setNumberElements(long min, long max)	Sets the minimum and maximum number of elements if an array.
protected void	setValueKnown(boolean known)	Sets a flag that the value is known to exist or not exist.
boolean	supportsCalendarType(Type calendarType)	Tests if the given calendar type is supported.
boolean	supportsCoordinateType(Type coordinateType)	Tests if the given coordinate type is supported.
boolean	supportsCurrencyType(Type currencyType)	Tests if the given currency type is supported.
boolean	supportsHeadingType(Type headingType)	Tests if the given heading type is supported.
boolean	supportsObjectType(Type objectType)	Tests if the given object type is supported.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string match type is supported.
boolean	supportsTimeType(Type timeType)	Tests if the given time type is supported.
boolean	supportsVersionType(Type versionType)	Tests if the given version type is supported.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SpatialUnitMetadata

public SpatialUnitMetadata(Id elementId)

Constructs a new single unlinked SpatialUnitMetadata.

Parameters:

elementId - the Id of the element

Throws:

NullArgumentException - elementId is null

SpatialUnitMetadata

public SpatialUnitMetadata(Id elementId,
 boolean isArray)

Constructs a new unlinked SpatialUnitMetadata.

Parameters:

elementId - the Id of the element

isArray - true if the element is an array another element, false if a single element

Throws:

NullArgumentException - elementId is null

SpatialUnitMetadata

public SpatialUnitMetadata(Id elementId,
 boolean isArray,
 boolean isLinked)

Constructs a new SpatialUnitMetadata.

Parameters:

elementId - the Id of the element

isArray - true if the element is an array another element, false if a single element

isLinked - true if the element is linked to another element, false otherwise

Throws:

NullArgumentException - elementId is null

Method Details

setLabel

public void setLabel(DisplayText label)

Sets the element label.

Overrides:

setLabel in class AbstractMetadata

Parameters:

label - the new element label

Throws:

NullArgumentException - label is null

setInstructions

public void setInstructions(DisplayText instructions)

Sets the instructions.

Overrides:

setInstructions in class AbstractMetadata

Parameters:

instructions - the new instructions

Throws:

NullArgumentException - instructions is null

setRequired

public void setRequired(boolean required)

Sets the required flag.

Overrides:

setRequired in class AbstractMetadata

Parameters:

required - true if required, false if optional

setValueExists

public void setValueExists(boolean exists)

Sets the has value flag.

Overrides:

setValueExists in class AbstractMetadata

Parameters:

exists - true if has existing value, false if no value exists

setReadOnly

public void setReadOnly(boolean readonly)

Sets the read only flag.

Overrides:

setReadOnly in class AbstractMetadata

Parameters:

readonly - true if read only, false if can be updated

setUnits

public void setUnits(DisplayText units)

Sets the units.

Overrides:

setUnits in class AbstractMetadata

Parameters:

units - the new units

Throws:

NullArgumentException - units is null

addSpatialUnitRecordType

public void addSpatialUnitRecordType(Type spatialUnitRecordType)

Add support for a spatial unit record type.

Overrides:

addSpatialUnitRecordType in class AbstractSpatialUnitMetadata

Parameters:

spatialUnitRecordType - the type of spatial unit record

Throws:

NullArgumentException - spatialUnitRecordType is null

setSpatialUnitSet

public void setSpatialUnitSet(Collection<SpatialUnit> values)

Sets the spatial unit set.

Overrides:

setSpatialUnitSet in class AbstractSpatialUnitMetadata

Parameters:

values - a collection of accepted spatial unit values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addToSpatialUnitSet

public void addToSpatialUnitSet(Collection<SpatialUnit> values)

Adds a collection of values to the spatial unit set.

Overrides:

addToSpatialUnitSet in class AbstractSpatialUnitMetadata

Parameters:

values - a collection of accepted spatial unit values

Throws:

NullArgumentException - values is null

addToSpatialUnitSet

public void addToSpatialUnitSet(SpatialUnit value)

Adds a value to the spatial unit set.

Overrides:

addToSpatialUnitSet in class AbstractSpatialUnitMetadata

Parameters:

value - a spatial unit value

Throws:

NullArgumentException - value is null

removeFromSpatialUnitSet

public void removeFromSpatialUnitSet(SpatialUnit value)

Removes a value from the spatial unit set.

Overrides:

removeFromSpatialUnitSet in class AbstractSpatialUnitMetadata

Parameters:

value - a spatial unit value

Throws:

NullArgumentException - value is null

clearSpatialUnitSet

public void clearSpatialUnitSet()

Clears the spatial unit set.

Overrides:

clearSpatialUnitSet in class AbstractSpatialUnitMetadata

setDefaultSpatialUnitValues

public void setDefaultSpatialUnitValues(Collection<SpatialUnit> values)

Sets the default spatial unit set.

Overrides:

setDefaultSpatialUnitValues in class AbstractSpatialUnitMetadata

Parameters:

values - a collection of default spatial unit values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addDefaultSpatialUnitValues

public void addDefaultSpatialUnitValues(Collection<SpatialUnit> values)

Adds a collection of default spatial unit values.

Overrides:

addDefaultSpatialUnitValues in class AbstractSpatialUnitMetadata

Parameters:

values - a collection of default spatial unit values

Throws:

NullArgumentException - values is null

addDefaultSpatialUnitValue

public void addDefaultSpatialUnitValue(SpatialUnit value)

Adds a default spatial unit value.

Overrides:

addDefaultSpatialUnitValue in class AbstractSpatialUnitMetadata

Parameters:

value - a spatial unit value

Throws:

NullArgumentException - value is null

removeDefaultSpatialUnitValue

public void removeDefaultSpatialUnitValue(SpatialUnit value)

Removes a default spatial unit value.

Overrides:

removeDefaultSpatialUnitValue in class AbstractSpatialUnitMetadata

Parameters:

value - a spatial unit value

Throws:

NullArgumentException - value is null

clearDefaultSpatialUnitValues

public void clearDefaultSpatialUnitValues()

Clears the default spatial unit values.

Overrides:

clearDefaultSpatialUnitValues in class AbstractSpatialUnitMetadata

setExistingSpatialUnitValues

public void setExistingSpatialUnitValues(Collection<SpatialUnit> values)

Sets the existing spatial unit set.

Overrides:

setExistingSpatialUnitValues in class AbstractSpatialUnitMetadata

Parameters:

values - a collection of existing spatial unit values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addExistingSpatialUnitValues

public void addExistingSpatialUnitValues(Collection<SpatialUnit> values)

Adds a collection of existing spatial unit values.

Overrides:

addExistingSpatialUnitValues in class AbstractSpatialUnitMetadata

Parameters:

values - a collection of existing spatial unit values

Throws:

NullArgumentException - values is null

addExistingSpatialUnitValue

public void addExistingSpatialUnitValue(SpatialUnit value)

Adds a existing spatial unit value.

Overrides:

addExistingSpatialUnitValue in class AbstractSpatialUnitMetadata

Parameters:

value - a spatial unit value

Throws:

NullArgumentException - value is null

removeExistingSpatialUnitValue

public void removeExistingSpatialUnitValue(SpatialUnit value)

Removes a existing spatial unit value.

Overrides:

removeExistingSpatialUnitValue in class AbstractSpatialUnitMetadata

Parameters:

value - a spatial unit value

Throws:

NullArgumentException - value is null

clearExistingSpatialUnitValues

public void clearExistingSpatialUnitValues()

Clears the existing spatial unit values.

Overrides:

clearExistingSpatialUnitValues in class AbstractSpatialUnitMetadata