Class HeadingMetadata

java.lang.Object

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

net.okapia.osid.jamocha.metadata.spi.AbstractHeadingMetadata

net.okapia.osid.jamocha.metadata.HeadingMetadata

All Implemented Interfaces:

Metadata

public final class HeadingMetadata
extends AbstractHeadingMetadata
implements Metadata

Defines a heading Metadata.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addDefaultHeadingValue(Heading value)	Adds a default heading value.
void	addDefaultHeadingValues(Collection<Heading> values)	Adds a collection of default heading values.
void	addExistingHeadingValue(Heading value)	Adds a existing heading value.
void	addExistingHeadingValues(Collection<Heading> values)	Adds a collection of existing heading values.
void	addHeadingType(Type headingType, long dimensions)	Add support for a heading type.
void	addToHeadingSet(Collection<Heading> values)	Adds a collection of values to the heading set.
void	addToHeadingSet(Heading value)	Adds a value to the heading set.
void	clearDefaultHeadingValues()	Clears the default heading values.
void	clearExistingHeadingValues()	Clears the existing heading values.
void	clearHeadingSet()	Clears the heading set.
void	removeDefaultHeadingValue(Heading value)	Removes a default heading value.
void	removeExistingHeadingValue(Heading value)	Removes a existing heading value.
void	removeFromHeadingSet(Heading value)	Removes a value from the heading set.
void	setDefaultHeadingValues(Collection<Heading> values)	Sets the default heading set.
void	setExistingHeadingValues(Collection<Heading> values)	Sets the existing heading set.
void	setHeadingRange(Heading min, Heading max)	Sets the heading range.
void	setHeadingSet(Collection<Heading> values)	Sets the heading 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	setValueExists(boolean exists)	Sets the has value flag.

Methods inherited from class AbstractHeadingMetadata

getAxesForHeadingType, getDefaultHeadingValues, getExistingHeadingValues, getHeadingSet, getHeadingTypes, getMaximumHeadingValues, getMinimumHeadingValues, supportsHeadingType

Modifier and Type	Method	Description
long	getAxesForHeadingType(Type headingType)	Gets the number of axes for a given supported heading type.
Heading[]	getDefaultHeadingValues()	Gets the default heading values.
Heading[]	getExistingHeadingValues()	Gets the existing heading values.
Heading[]	getHeadingSet()	Gets the set of acceptable heading values.
Type[]	getHeadingTypes()	Gets the set of acceptable heading types.
BigDecimal[]	getMaximumHeadingValues(Type headingType)	Gets the maximum heading values given supported heading type.
BigDecimal[]	getMinimumHeadingValues(Type headingType)	Gets the minimum heading values given supported heading type.
boolean	supportsHeadingType(Type headingType)	Tests if the given heading type is supported.

Methods inherited from class AbstractMetadata

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

Modifier and Type	Method	Description
long	getAxesForCoordinateType(Type coordinateType)	Gets the number of axes for a given supported coordinate 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.
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.
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.
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.
Version[]	getExistingVersionValues()	Gets the existing version values.
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.
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.
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.
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').
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	setUnits(DisplayText units)	Sets the units.
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	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.
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

HeadingMetadata

public HeadingMetadata(Id elementId)

Constructs a new single unlinked HeadingMetadata.

Parameters:

elementId - the Id of the element

Throws:

NullArgumentException - elementId is null

HeadingMetadata

public HeadingMetadata(Id elementId,
 boolean isArray)

Constructs a new unlinked HeadingMetadata.

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

HeadingMetadata

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

Constructs a new HeadingMetadata.

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

addHeadingType

public void addHeadingType(Type headingType,
 long dimensions)

Add support for a heading type.

Overrides:

addHeadingType in class AbstractHeadingMetadata

Parameters:

headingType - the type of heading

dimensions - the number of dimensions for the type

Throws:

InvalidArgumentException - dimensions is negative

NullArgumentException - headingType is null

setHeadingRange

public void setHeadingRange(Heading min,
 Heading max)

Sets the heading range.

Overrides:

setHeadingRange in class AbstractHeadingMetadata

Parameters:

min - the minimum value

max - the maximum value

Throws:

InvalidArgumentException - min is greater than max or, min or max is negative

UnsupportedException - types not supported

setHeadingSet

public void setHeadingSet(Collection<Heading> values)

Sets the heading set.

Overrides:

setHeadingSet in class AbstractHeadingMetadata

Parameters:

values - a collection of accepted heading values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addToHeadingSet

public void addToHeadingSet(Collection<Heading> values)

Adds a collection of values to the heading set.

Overrides:

addToHeadingSet in class AbstractHeadingMetadata

Parameters:

values - a collection of accepted heading values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addToHeadingSet

public void addToHeadingSet(Heading value)

Adds a value to the heading set.

Overrides:

addToHeadingSet in class AbstractHeadingMetadata

Parameters:

value - a heading value

Throws:

InvalidArgumentException - value is negative

removeFromHeadingSet

public void removeFromHeadingSet(Heading value)

Removes a value from the heading set.

Overrides:

removeFromHeadingSet in class AbstractHeadingMetadata

Parameters:

value - a heading value

Throws:

InvalidArgumentException - value is negative

clearHeadingSet

public void clearHeadingSet()

Clears the heading set.

Overrides:

clearHeadingSet in class AbstractHeadingMetadata

setDefaultHeadingValues

public void setDefaultHeadingValues(Collection<Heading> values)

Sets the default heading set.

Overrides:

setDefaultHeadingValues in class AbstractHeadingMetadata

Parameters:

values - a collection of default heading values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addDefaultHeadingValues

public void addDefaultHeadingValues(Collection<Heading> values)

Adds a collection of default heading values.

Overrides:

addDefaultHeadingValues in class AbstractHeadingMetadata

Parameters:

values - a collection of default heading values

Throws:

NullArgumentException - values is null

addDefaultHeadingValue

public void addDefaultHeadingValue(Heading value)

Adds a default heading value.

Overrides:

addDefaultHeadingValue in class AbstractHeadingMetadata

Parameters:

value - a heading value

Throws:

NullArgumentException - value is null

removeDefaultHeadingValue

public void removeDefaultHeadingValue(Heading value)

Removes a default heading value.

Overrides:

removeDefaultHeadingValue in class AbstractHeadingMetadata

Parameters:

value - a heading value

Throws:

NullArgumentException - value is null

clearDefaultHeadingValues

public void clearDefaultHeadingValues()

Clears the default heading values.

Overrides:

clearDefaultHeadingValues in class AbstractHeadingMetadata

setExistingHeadingValues

public void setExistingHeadingValues(Collection<Heading> values)

Sets the existing heading set.

Overrides:

setExistingHeadingValues in class AbstractHeadingMetadata

Parameters:

values - a collection of existing heading values

Throws:

InvalidArgumentException - a value is negative

NullArgumentException - values is null

addExistingHeadingValues

public void addExistingHeadingValues(Collection<Heading> values)

Adds a collection of existing heading values.

Overrides:

addExistingHeadingValues in class AbstractHeadingMetadata

Parameters:

values - a collection of existing heading values

Throws:

NullArgumentException - values is null

addExistingHeadingValue

public void addExistingHeadingValue(Heading value)

Adds a existing heading value.

Overrides:

addExistingHeadingValue in class AbstractHeadingMetadata

Parameters:

value - a heading value

Throws:

NullArgumentException - value is null

removeExistingHeadingValue

public void removeExistingHeadingValue(Heading value)

Removes a existing heading value.

Overrides:

removeExistingHeadingValue in class AbstractHeadingMetadata

Parameters:

value - a heading value

Throws:

NullArgumentException - value is null

clearExistingHeadingValues

public void clearExistingHeadingValues()

Clears the existing heading values.

Overrides:

clearExistingHeadingValues in class AbstractHeadingMetadata