de.micromata.opengis.kml.v_2_2_0
Class TimeSpan

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.TimePrimitive
          extended by de.micromata.opengis.kml.v_2_2_0.TimeSpan
All Implemented Interfaces:
java.lang.Cloneable

public class TimeSpan
extends TimePrimitive
implements java.lang.Cloneable

and

If or is missing, then that end of the period is unbounded (see Example below).

Represents an extent in time bounded by begin and end dateTimes.

The dateTime is defined according to XML Schema time (see XML Schema Part 2: Datatypes Second Edition). The value can be expressed as yyyy-mm-ddThh:mm:sszzzzzz, where T is the separator between the date and the time, and the time zone is either Z (for UTC) or zzzzzz, which represents ±hh:mm in relation to UTC. Additionally, the value can be expressed as a date only. See for examples.

Syntax:
<TimeSpan id="ID">
   <begin>...</begin>     <!-- kml:dateTime -->
   <end>...</end>         <!-- kml:dateTime -->
 </TimeSpan>
Extends:


Field Summary
protected  java.lang.String begin
          
protected  java.lang.String end
          
protected  java.util.List<AbstractObject> timeSpanObjectExtension
          
protected  java.util.List<java.lang.Object> timeSpanSimpleExtension
           
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.TimePrimitive
timePrimitiveObjectExtension, timePrimitiveSimpleExtension
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
TimeSpan()
           
 
Method Summary
 TimeSpan addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 TimeSpan addToTimePrimitiveObjectExtension(AbstractObject timePrimitiveObjectExtension)
          add a value to the timePrimitiveObjectExtension property collection
 TimeSpan addToTimePrimitiveSimpleExtension(java.lang.Object timePrimitiveSimpleExtension)
          add a value to the timePrimitiveSimpleExtension property collection
 TimeSpan addToTimeSpanObjectExtension(AbstractObject timeSpanObjectExtension)
          add a value to the timeSpanObjectExtension property collection
 TimeSpan addToTimeSpanSimpleExtension(java.lang.Object timeSpanSimpleExtension)
          add a value to the timeSpanSimpleExtension property collection
 TimeSpan clone()
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getBegin()
           
 java.lang.String getEnd()
           
 java.util.List<AbstractObject> getTimeSpanObjectExtension()
           
 java.util.List<java.lang.Object> getTimeSpanSimpleExtension()
           
 int hashCode()
           
 void setBegin(java.lang.String value)
           
 void setEnd(java.lang.String value)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setTimePrimitiveObjectExtension(java.util.List<AbstractObject> timePrimitiveObjectExtension)
           
 void setTimePrimitiveSimpleExtension(java.util.List<java.lang.Object> timePrimitiveSimpleExtension)
           
 void setTimeSpanObjectExtension(java.util.List<AbstractObject> timeSpanObjectExtension)
           
 void setTimeSpanSimpleExtension(java.util.List<java.lang.Object> timeSpanSimpleExtension)
           
 TimeSpan withBegin(java.lang.String begin)
          fluent setter
 TimeSpan withEnd(java.lang.String end)
          fluent setter
 TimeSpan withId(java.lang.String id)
          fluent setter
 TimeSpan withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 TimeSpan withTargetId(java.lang.String targetId)
          fluent setter
 TimeSpan withTimePrimitiveObjectExtension(java.util.List<AbstractObject> timePrimitiveObjectExtension)
          fluent setter
 TimeSpan withTimePrimitiveSimpleExtension(java.util.List<java.lang.Object> timePrimitiveSimpleExtension)
          fluent setter
 TimeSpan withTimeSpanObjectExtension(java.util.List<AbstractObject> timeSpanObjectExtension)
          fluent setter
 TimeSpan withTimeSpanSimpleExtension(java.util.List<java.lang.Object> timeSpanSimpleExtension)
          fluent setter
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.TimePrimitive
getTimePrimitiveObjectExtension, getTimePrimitiveSimpleExtension
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
getId, getObjectSimpleExtension, getTargetId, setId, setTargetId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

begin

protected java.lang.String begin

Describes the beginning instant of a time period. If absent, the beginning of the period is unbounded.


end

protected java.lang.String end

Describes the ending instant of a time period. If absent, the end of the period is unbounded.


timeSpanSimpleExtension

protected java.util.List<java.lang.Object> timeSpanSimpleExtension

timeSpanObjectExtension

protected java.util.List<AbstractObject> timeSpanObjectExtension

This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the mechanism is to be used.

Syntax:
<!-- abstract element; do not create -->
 <!-- Object id="ID" targetId="NCName" -->
 <!-- /Object> -->

Constructor Detail

TimeSpan

public TimeSpan()
Method Detail

getBegin

public java.lang.String getBegin()
Returns:
possible object is String
See Also:
begin

setBegin

public void setBegin(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
begin

getEnd

public java.lang.String getEnd()
Returns:
possible object is String
See Also:
end

setEnd

public void setEnd(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
end

getTimeSpanSimpleExtension

public java.util.List<java.lang.Object> getTimeSpanSimpleExtension()
See Also:
timeSpanSimpleExtension

getTimeSpanObjectExtension

public java.util.List<AbstractObject> getTimeSpanObjectExtension()
See Also:
timeSpanObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class TimePrimitive

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class TimePrimitive

setTimeSpanSimpleExtension

public void setTimeSpanSimpleExtension(java.util.List<java.lang.Object> timeSpanSimpleExtension)
Parameters:
timeSpanSimpleExtension -
See Also:
timeSpanSimpleExtension

addToTimeSpanSimpleExtension

public TimeSpan addToTimeSpanSimpleExtension(java.lang.Object timeSpanSimpleExtension)
add a value to the timeSpanSimpleExtension property collection

Parameters:
timeSpanSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setTimeSpanObjectExtension

public void setTimeSpanObjectExtension(java.util.List<AbstractObject> timeSpanObjectExtension)
Parameters:
timeSpanObjectExtension -
See Also:
timeSpanObjectExtension

addToTimeSpanObjectExtension

public TimeSpan addToTimeSpanObjectExtension(AbstractObject timeSpanObjectExtension)
add a value to the timeSpanObjectExtension property collection

Parameters:
timeSpanObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setObjectSimpleExtension

public void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Overrides:
setObjectSimpleExtension in class TimePrimitive
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public TimeSpan addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection

Overrides:
addToObjectSimpleExtension in class TimePrimitive
Parameters:
objectSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setTimePrimitiveSimpleExtension

public void setTimePrimitiveSimpleExtension(java.util.List<java.lang.Object> timePrimitiveSimpleExtension)
Overrides:
setTimePrimitiveSimpleExtension in class TimePrimitive
See Also:
timePrimitiveSimpleExtension

addToTimePrimitiveSimpleExtension

public TimeSpan addToTimePrimitiveSimpleExtension(java.lang.Object timePrimitiveSimpleExtension)
Description copied from class: TimePrimitive
add a value to the timePrimitiveSimpleExtension property collection

Overrides:
addToTimePrimitiveSimpleExtension in class TimePrimitive
Parameters:
timePrimitiveSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setTimePrimitiveObjectExtension

public void setTimePrimitiveObjectExtension(java.util.List<AbstractObject> timePrimitiveObjectExtension)
Overrides:
setTimePrimitiveObjectExtension in class TimePrimitive
See Also:
timePrimitiveObjectExtension

addToTimePrimitiveObjectExtension

public TimeSpan addToTimePrimitiveObjectExtension(AbstractObject timePrimitiveObjectExtension)
Description copied from class: TimePrimitive
add a value to the timePrimitiveObjectExtension property collection

Overrides:
addToTimePrimitiveObjectExtension in class TimePrimitive
Parameters:
timePrimitiveObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

withBegin

public TimeSpan withBegin(java.lang.String begin)
fluent setter

Parameters:
begin - required parameter
See Also:
setBegin(String)

withEnd

public TimeSpan withEnd(java.lang.String end)
fluent setter

Parameters:
end - required parameter
See Also:
setEnd(String)

withTimeSpanSimpleExtension

public TimeSpan withTimeSpanSimpleExtension(java.util.List<java.lang.Object> timeSpanSimpleExtension)
fluent setter

Parameters:
timeSpanSimpleExtension - required parameter
See Also:
#setTimeSpanSimpleExtension(List)

withTimeSpanObjectExtension

public TimeSpan withTimeSpanObjectExtension(java.util.List<AbstractObject> timeSpanObjectExtension)
fluent setter

Parameters:
timeSpanObjectExtension - required parameter
See Also:
#setTimeSpanObjectExtension(List)

withObjectSimpleExtension

public TimeSpan withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class TimePrimitive
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public TimeSpan withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class TimePrimitive
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public TimeSpan withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class TimePrimitive
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

withTimePrimitiveSimpleExtension

public TimeSpan withTimePrimitiveSimpleExtension(java.util.List<java.lang.Object> timePrimitiveSimpleExtension)
Description copied from class: TimePrimitive
fluent setter

Overrides:
withTimePrimitiveSimpleExtension in class TimePrimitive
Parameters:
timePrimitiveSimpleExtension - required parameter
See Also:
#setTimePrimitiveSimpleExtension(List)

withTimePrimitiveObjectExtension

public TimeSpan withTimePrimitiveObjectExtension(java.util.List<AbstractObject> timePrimitiveObjectExtension)
Description copied from class: TimePrimitive
fluent setter

Overrides:
withTimePrimitiveObjectExtension in class TimePrimitive
Parameters:
timePrimitiveObjectExtension - required parameter
See Also:
#setTimePrimitiveObjectExtension(List)

clone

public TimeSpan clone()
Overrides:
clone in class TimePrimitive