TLcdKML22TimeSpan (LuciadLightspeed API documentation)

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.TLcdKML22TimeSpan

All Implemented Interfaces:: ILcdDataObject, ILcdEditableTimeBounds, ILcdTimeBounds, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdKML22TimeSpan
extends TLcdKML22AbstractTimePrimitive
implements ILcdEditableTimeBounds

Domain class modeling the KML TimeSpanType type.

OGC KML Specification description:

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

  -kml:AbstractTimePrimitiveGroup

 Specifies an extent in time bounded by begin and end temporal values. At least one of the
 child elements kml:begin and kml:end shall be encoded.

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 and Description
`static TLcdDataProperty`	`BEGIN_PROPERTY` Data property that maps to the `begin` element.
`static TLcdDataProperty`	`END_PROPERTY` Data property that maps to the `end` element.
`static TLcdDataProperty`	`TIME_SPAN_OBJECT_EXTENSION_GROUP_PROPERTY` Data property that maps to the `TimeSpanObjectExtensionGroup` element.
`static TLcdDataProperty`	`TIME_SPAN_SIMPLE_EXTENSION_GROUP_PROPERTY` Data property that maps to the `TimeSpanSimpleExtensionGroup` 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 and Description

TLcdKML22TimeSpan(TLcdDataType aType)
Creates a new TLcdKML22TimeSpan with a custom TLcdDataType.

Constructors
Constructor and Description
`TLcdKML22TimeSpan(TLcdDataType aType)` Creates a new `TLcdKML22TimeSpan` with a custom `TLcdDataType`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XMLGregorianCalendar`	`getBegin()` Returns the value of the property that maps to the `begin` element.
`long`	`getBeginTime()` Returns the begin time of this `ILcdTimeBounds`.
`ILcdTimeBounds.Boundedness`	`getBeginTimeBoundedness()` Returns the boundedness of the begin time.
`XMLGregorianCalendar`	`getEnd()` Returns the value of the property that maps to the `end` element.
`long`	`getEndTime()` Returns the end time of this `ILcdTimeBounds`.
`ILcdTimeBounds.Boundedness`	`getEndTimeBoundedness()` Returns the boundedness of the end time.
`void`	`setBegin(XMLGregorianCalendar aValue)` Sets the value of the property that maps to the `begin` 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`	`setEnd(XMLGregorianCalendar aValue)` Sets the value of the property that maps to the `end` element.
`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.

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 Detail
  - BEGIN_PROPERTY
```
public static final TLcdDataProperty BEGIN_PROPERTY
```
    Data property that maps to the begin element. The possible values for this property are instances of
    - XMLGregorianCalendar
  - END_PROPERTY
```
public static final TLcdDataProperty END_PROPERTY
```
    Data property that maps to the end element. The possible values for this property are instances of
    - XMLGregorianCalendar
  - TIME_SPAN_SIMPLE_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty TIME_SPAN_SIMPLE_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the TimeSpanSimpleExtensionGroup element. The possible values for this property are instances of List<String>.
  - TIME_SPAN_OBJECT_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty TIME_SPAN_OBJECT_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the TimeSpanObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.
- Constructor Detail
  - TLcdKML22TimeSpan
```
public TLcdKML22TimeSpan(TLcdDataType aType)
```
    Creates a new TLcdKML22TimeSpan with a custom TLcdDataType.
    
    Parameters:
    
    aType - a custom TLcdDataType
- Method Detail
  - 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.
  - getBegin
```
public XMLGregorianCalendar getBegin()
```
    Returns the value of the property that maps to the begin element.
    The possible values for this property are instances of
    - XMLGregorianCalendar
    Returns:
    
    the value of the BEGIN_PROPERTY property.
  - setBegin
```
public void setBegin(XMLGregorianCalendar aValue)
```
    Sets the value of the property that maps to the begin element.
    The possible values for this property are instances of
    - XMLGregorianCalendar
    Parameters:
    
    aValue - the value to set for the BEGIN_PROPERTY property.
  - getEnd
```
public XMLGregorianCalendar getEnd()
```
    Returns the value of the property that maps to the end element.
    The possible values for this property are instances of
    - XMLGregorianCalendar
    Returns:
    
    the value of the END_PROPERTY property.
  - setEnd
```
public void setEnd(XMLGregorianCalendar aValue)
```
    Sets the value of the property that maps to the end element.
    The possible values for this property are instances of
    - XMLGregorianCalendar
    Parameters:
    
    aValue - the value to set for the END_PROPERTY property.

LuciadLightspeedClass TLcdKML22TimeSpan

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.shape.ILcdEditableTimeBounds

Field Detail

BEGIN_PROPERTY

END_PROPERTY

TIME_SPAN_SIMPLE_EXTENSION_GROUP_PROPERTY

TIME_SPAN_OBJECT_EXTENSION_GROUP_PROPERTY

Constructor Detail

TLcdKML22TimeSpan

Method Detail

setValue

setBeginTimeBoundedness

setEndTimeBoundedness

setBeginTime

setEndTime

getBeginTimeBoundedness

getEndTimeBoundedness

getBeginTime

getEndTime

getBegin

setBegin

getEnd

setEnd