Package com.luciad.format.kml22.model.time

Class TLcdKML22TimeStamp

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.format.kml22.model.TLcdKML22AbstractObject

com.luciad.format.kml22.model.time.TLcdKML22AbstractTimePrimitive

com.luciad.format.kml22.model.time.TLcdKML22TimeStamp

All Implemented Interfaces:

ILcdDataObject, ILcdEditableTimeBounds, ILcdTimeBounds, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdKML22TimeStamp
extends TLcdKML22AbstractTimePrimitive
implements ILcdEditableTimeBounds

Domain class modeling the KML TimeStampType type.

OGC KML Specification description:

 This element can be used wherever the following element is referenced:

  -kml:AbstractTimePrimitiveGroup

 Specifies a single moment in time within the required kml:when child element.
 

Since:

10.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.luciad.shape.ILcdTimeBounds

ILcdTimeBounds.Boundedness

Field Summary

Fields

Modifier and Type	Field	Description
static final TLcdDataProperty	TIME_STAMP_OBJECT_EXTENSION_GROUP_PROPERTY	Data property that maps to the TimeStampObjectExtensionGroup element.
static final TLcdDataProperty	TIME_STAMP_SIMPLE_EXTENSION_GROUP_PROPERTY	Data property that maps to the TimeStampSimpleExtensionGroup element.
static final TLcdDataProperty	WHEN_PROPERTY	Data property that maps to the when element.

Fields inherited from class com.luciad.format.kml22.model.time.TLcdKML22AbstractTimePrimitive

ABSTRACT_TIME_PRIMITIVE_OBJECT_EXTENSION_GROUP_PROPERTY, ABSTRACT_TIME_PRIMITIVE_SIMPLE_EXTENSION_GROUP_PROPERTY

Fields inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject

ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdKML22TimeStamp(TLcdDataType aType)	Creates a new TLcdKML22TimeStamp with a custom TLcdDataType.

Method Summary

Modifier and Type	Method	Description
long	getBeginTime()	Returns the begin time of this ILcdTimeBounds.
ILcdTimeBounds.Boundedness	getBeginTimeBoundedness()	Returns the boundedness of the begin time.
long	getEndTime()	Returns the end time of this ILcdTimeBounds.
ILcdTimeBounds.Boundedness	getEndTimeBoundedness()	Returns the boundedness of the end time.
XMLGregorianCalendar	getWhen()	Returns the value of the property that maps to the when element.
void	setBeginTime(long l)	Adjusts the begin time of this ILcdTimeBounds.
void	setBeginTimeBoundedness(ILcdTimeBounds.Boundedness aBoundedness)	Adjusts the boundedness of the begin time.
void	setEndTime(long l)	Adjusts the end time of this ILcdTimeBounds.
void	setEndTimeBoundedness(ILcdTimeBounds.Boundedness aBoundedness)	Adjusts the boundedness of the end time.
void	setValue(TLcdDataProperty aProperty, Object aValue)	Sets the value of the given property for this data object.
void	setWhen(XMLGregorianCalendar aValue)	Sets the value of the property that maps to the when element.

Methods inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject

getId, getTargetId, setId, setTargetId

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.shape.ILcdEditableTimeBounds

setToIncludeTime, setToUnion

Field Details

WHEN_PROPERTY

public static final TLcdDataProperty WHEN_PROPERTY

Data property that maps to the when element. The possible values for this property are instances of

• XMLGregorianCalendar

TIME_STAMP_SIMPLE_EXTENSION_GROUP_PROPERTY

public static final TLcdDataProperty TIME_STAMP_SIMPLE_EXTENSION_GROUP_PROPERTY

Data property that maps to the TimeStampSimpleExtensionGroup element. The possible values for this property are instances of List<String>.

TIME_STAMP_OBJECT_EXTENSION_GROUP_PROPERTY

public static final TLcdDataProperty TIME_STAMP_OBJECT_EXTENSION_GROUP_PROPERTY

Data property that maps to the TimeStampObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

Constructor Details

TLcdKML22TimeStamp

public TLcdKML22TimeStamp(TLcdDataType aType)

Creates a new TLcdKML22TimeStamp with a custom TLcdDataType.

Parameters:

aType - a custom TLcdDataType

Method Details

setValue

public void setValue(TLcdDataProperty aProperty,
 Object aValue)

Description copied from interface: ILcdDataObject

Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.

The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.

Specified by:

setValue in interface ILcdDataObject

Overrides:

setValue in class TLcdDataObject

Parameters:

aProperty - the property for which the value is to be set

aValue - the value to set

See Also:

• TLcdDataType.getProperty(String)

setBeginTimeBoundedness

public void setBeginTimeBoundedness(ILcdTimeBounds.Boundedness aBoundedness)

Description copied from interface: ILcdEditableTimeBounds

Adjusts the boundedness of the begin time.

Specified by:

setBeginTimeBoundedness in interface ILcdEditableTimeBounds

Parameters:

aBoundedness - the new boundedness of the begin time.

See Also:

• ILcdTimeBounds.getBeginTimeBoundedness()

setEndTimeBoundedness

public void setEndTimeBoundedness(ILcdTimeBounds.Boundedness aBoundedness)

Description copied from interface: ILcdEditableTimeBounds

Adjusts the boundedness of the end time.

Specified by:

setEndTimeBoundedness in interface ILcdEditableTimeBounds

Parameters:

aBoundedness - the new boundedness of the end time.

See Also:

• ILcdTimeBounds.getEndTimeBoundedness()

setBeginTime

public void setBeginTime(long l)

Description copied from interface: ILcdEditableTimeBounds

Adjusts the begin time of this ILcdTimeBounds. The long value is defined as in Date.getTime().

Specified by:

setBeginTime in interface ILcdEditableTimeBounds

Parameters:

l - the new begin time of this ILcdTimeBounds.

See Also:

• ILcdTimeBounds.getBeginTime()

setEndTime

public void setEndTime(long l)

Description copied from interface: ILcdEditableTimeBounds

Adjusts the end time of this ILcdTimeBounds. The long value is defined as in Date.getTime().

Specified by:

setEndTime in interface ILcdEditableTimeBounds

Parameters:

l - the new end time of this ILcdTimeBounds.

See Also:

• ILcdTimeBounds.getEndTime()

getBeginTimeBoundedness

public ILcdTimeBounds.Boundedness getBeginTimeBoundedness()

Description copied from interface: ILcdTimeBounds

Returns the boundedness of the begin time. This method can be used to check whether the begin time is undefined, bounded or unbounded.

Specified by:

getBeginTimeBoundedness in interface ILcdTimeBounds

Returns:

the boundedness of the begin time.

getEndTimeBoundedness

public ILcdTimeBounds.Boundedness getEndTimeBoundedness()

Description copied from interface: ILcdTimeBounds

Returns the boundedness of the end time. This method can be used to check whether the end time is undefined, bounded or unbounded.

Specified by:

getEndTimeBoundedness in interface ILcdTimeBounds

Returns:

the boundedness of the end time.

getBeginTime

public long getBeginTime()

Description copied from interface: ILcdTimeBounds

Returns the begin time of this ILcdTimeBounds. The long value is defined as in Date.getTime().

This method should only be called if the corresponding boundedness is ILcdTimeBounds.Boundedness.BOUNDED. Otherwise, the return value of this method is undefined.

Specified by:

getBeginTime in interface ILcdTimeBounds

Returns:

the begin time of this ILcdTimeBounds.

getEndTime

public long getEndTime()

Description copied from interface: ILcdTimeBounds

Returns the end time of this ILcdTimeBounds. The long value is defined as in Date.getTime().

This method should only be called if the corresponding boundedness is ILcdTimeBounds.Boundedness.BOUNDED. Otherwise, the return value of this method is undefined.

Specified by:

getEndTime in interface ILcdTimeBounds

Returns:

the end time of this ILcdTimeBounds.

getWhen

public XMLGregorianCalendar getWhen()

Returns the value of the property that maps to the when element.

The possible values for this property are instances of

• XMLGregorianCalendar

Returns:

the value of the WHEN_PROPERTY property.

setWhen

public void setWhen(XMLGregorianCalendar aValue)

Sets the value of the property that maps to the when element.

The possible values for this property are instances of

• XMLGregorianCalendar

Parameters:

aValue - the value to set for the WHEN_PROPERTY property.