Class VersionMetadata

java.lang.Object

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

net.okapia.osid.jamocha.metadata.spi.AbstractVersionMetadata

net.okapia.osid.jamocha.metadata.VersionMetadata

All Implemented Interfaces:

Metadata

public final class VersionMetadata
extends AbstractVersionMetadata
implements Metadata

Defines a version Metadata.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addDefaultVersionValue(Version value)	Adds a default version value.
void	addDefaultVersionValues(Collection<Version> values)	Adds a collection of default version values.
void	addExistingVersionValue(Version value)	Adds a existing version value.
void	addExistingVersionValues(Collection<Version> values)	Adds a collection of existing version values.
void	addToVersionSet(Collection<Version> values)	Adds a collection of values to the version set.
void	addToVersionSet(Version value)	Adds a value to the version set.
void	addVersionType(Type versionType)	Add support for a version type.
void	clearDefaultVersionValues()	Clears the default version values.
void	clearExistingVersionValues()	Clears the existing version values.
void	clearVersionSet()	Clears the version set.
void	removeDefaultVersionValue(Version value)	Removes a default version value.
void	removeExistingVersionValue(Version value)	Removes a existing version value.
void	removeFromVersionSet(Version value)	Removes a value from the version set.
void	setDefaultVersionValues(Collection<Version> values)	Sets the default version set.
void	setExistingVersionValues(Collection<Version> values)	Sets the existing version 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	setUnits(DisplayText units)	Sets the units.
void	setValueExists(boolean exists)	Sets the has value flag.
void	setVersionRange(Version min, Version max)	Sets the min and max versions.
void	setVersionSet(Collection<Version> values)	Sets the version set.

Methods inherited from class AbstractVersionMetadata

getDefaultVersionValues, getExistingVersionValues, getMaximumVersion, getMinimumVersion, getVersionSet, getVersionTypes, supportsVersionType

Modifier and Type	Method	Description
Version[]	getDefaultVersionValues()	Gets the default version values.
Version[]	getExistingVersionValues()	Gets the existing version values.
Version	getMaximumVersion()	Gets the maximum version value.
Version	getMinimumVersion()	Gets the minimum version value.
Version[]	getVersionSet()	Gets the set of acceptable version values.
Type[]	getVersionTypes()	Gets the set of acceptable version types.
boolean	supportsVersionType(Type versionType)	Tests if the given version type is supported.

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, getDefaultSpatialUnitValues, getDefaultSpeedValues, getDefaultStringValues, getDefaultTimeValues, getDefaultTypeValues, getDistanceResolution, getDistanceSet, getDurationSet, getElementId, getElementLabel, getExistingCardinalValues, getExistingCoordinateValues, getExistingCurrencyValues, getExistingDateTimeValues, getExistingDecimalValues, getExistingDistanceValues, getExistingDurationValues, getExistingHeadingValues, getExistingIdValues, getExistingIntegerValues, getExistingObjectValues, getExistingSpatialUnitValues, getExistingSpeedValues, getExistingStringValues, getExistingTimeValues, getExistingTypeValues, getHeadingSet, getHeadingTypes, getIdSet, getInstructions, getIntegerSet, getMaximumCardinal, getMaximumCoordinateValues, getMaximumCurrency, getMaximumDateTime, getMaximumDecimal, getMaximumDistance, getMaximumDuration, getMaximumElements, getMaximumHeadingValues, getMaximumInteger, getMaximumSpeed, getMaximumStringLength, getMaximumTime, getMinimumCardinal, getMinimumCoordinateValues, getMinimumCurrency, getMinimumDateTime, getMinimumDecimal, getMinimumDistance, getMinimumDuration, getMinimumElements, getMinimumHeadingValues, getMinimumInteger, getMinimumSpeed, getMinimumStringLength, getMinimumTime, getObjectSet, getObjectTypes, getSpatialUnitRecordTypes, getSpatialUnitSet, getSpeedSet, getStringExpression, getStringFormatTypes, getStringMatchTypes, getStringSet, getSyntax, getTimeSet, getTimeTypes, getTypeSet, getUnits, hasValue, isArray, isLinked, isReadOnly, isRequired, isValueKnown, setNumberElements, setValueKnown, supportsCalendarType, supportsCoordinateType, supportsCurrencyType, supportsHeadingType, supportsObjectType, supportsSpatialUnitRecordType, supportsStringMatchType, supportsTimeType

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.
SpatialUnit[]	getDefaultSpatialUnitValues()	Deprecated. spatial units are deprecated in the OSID specification
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.
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.
SpatialUnit[]	getExistingSpatialUnitValues()	Deprecated. spatial units are deprecated in the OSID specification
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.
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.
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.
Object[]	getObjectSet()	Gets the set of acceptable object values.
Type[]	getObjectTypes()	Gets the set of acceptable Types for an arbitrary object.
Type[]	getSpatialUnitRecordTypes()	Deprecated. spatial units are deprecated in the OSID specification
SpatialUnit[]	getSpatialUnitSet()	Deprecated. spatial units are deprecated in the OSID specification
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').
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	supportsSpatialUnitRecordType(Type spatialUnitRecordType)	Deprecated. spatial units are deprecated in the OSID specification
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.

Methods inherited from class Object

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

Constructor Details

VersionMetadata

public VersionMetadata(Id elementId)

Constructs a new single unlinked VersionMetadata.

Parameters:

elementId - the Id of the element

Throws:

NullArgumentException - elementId is null

VersionMetadata

public VersionMetadata(Id elementId,
 boolean isArray)

Constructs a new unlinked VersionMetadata.

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

VersionMetadata

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

Constructs a new VersionMetadata.

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

addVersionType

public void addVersionType(Type versionType)

Add support for a version type.

Overrides:

addVersionType in class AbstractVersionMetadata

Parameters:

versionType - the type of version

Throws:

NullArgumentException - versionType is null

setVersionRange

public void setVersionRange(Version min,
 Version max)

Sets the min and max versions.

Overrides:

setVersionRange in class AbstractVersionMetadata

Parameters:

min - the minimum value

max - the maximum value

Throws:

InvalidArgumentException - min is newer than max

NullArgumentException - min or max is null

setVersionSet

public void setVersionSet(Collection<Version> values)

Sets the version set.

Overrides:

setVersionSet in class AbstractVersionMetadata

Parameters:

values - a collection of accepted version values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addToVersionSet

public void addToVersionSet(Collection<Version> values)

Adds a collection of values to the version set.

Overrides:

addToVersionSet in class AbstractVersionMetadata

Parameters:

values - a collection of accepted version values

Throws:

NullArgumentException - values is null

addToVersionSet

public void addToVersionSet(Version value)

Adds a value to the version set.

Overrides:

addToVersionSet in class AbstractVersionMetadata

Parameters:

value - a version value

Throws:

NullArgumentException - value is null

removeFromVersionSet

public void removeFromVersionSet(Version value)

Removes a value from the version set.

Overrides:

removeFromVersionSet in class AbstractVersionMetadata

Parameters:

value - a version value

Throws:

NullArgumentException - value is null

clearVersionSet

public void clearVersionSet()

Clears the version set.

Overrides:

clearVersionSet in class AbstractVersionMetadata

setDefaultVersionValues

public void setDefaultVersionValues(Collection<Version> values)

Sets the default version set.

Overrides:

setDefaultVersionValues in class AbstractVersionMetadata

Parameters:

values - a collection of default version values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addDefaultVersionValues

public void addDefaultVersionValues(Collection<Version> values)

Adds a collection of default version values.

Overrides:

addDefaultVersionValues in class AbstractVersionMetadata

Parameters:

values - a collection of default version values

Throws:

NullArgumentException - values is null

addDefaultVersionValue

public void addDefaultVersionValue(Version value)

Adds a default version value.

Overrides:

addDefaultVersionValue in class AbstractVersionMetadata

Parameters:

value - a version value

Throws:

NullArgumentException - value is null

removeDefaultVersionValue

public void removeDefaultVersionValue(Version value)

Removes a default version value.

Overrides:

removeDefaultVersionValue in class AbstractVersionMetadata

Parameters:

value - a version value

Throws:

NullArgumentException - value is null

clearDefaultVersionValues

public void clearDefaultVersionValues()

Clears the default version values.

Overrides:

clearDefaultVersionValues in class AbstractVersionMetadata

setExistingVersionValues

public void setExistingVersionValues(Collection<Version> values)

Sets the existing version set.

Overrides:

setExistingVersionValues in class AbstractVersionMetadata

Parameters:

values - a collection of existing version values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addExistingVersionValues

public void addExistingVersionValues(Collection<Version> values)

Adds a collection of existing version values.

Overrides:

addExistingVersionValues in class AbstractVersionMetadata

Parameters:

values - a collection of existing version values

Throws:

NullArgumentException - values is null

addExistingVersionValue

public void addExistingVersionValue(Version value)

Adds a existing version value.

Overrides:

addExistingVersionValue in class AbstractVersionMetadata

Parameters:

value - a version value

Throws:

NullArgumentException - value is null

removeExistingVersionValue

public void removeExistingVersionValue(Version value)

Removes a existing version value.

Overrides:

removeExistingVersionValue in class AbstractVersionMetadata

Parameters:

value - a version value

Throws:

NullArgumentException - value is null

clearExistingVersionValues

public void clearExistingVersionValues()

Clears the existing version values.

Overrides:

clearExistingVersionValues in class AbstractVersionMetadata