TLcdOGCBinaryTemporalOperator (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.ogc.filter.model.TLcdOGCBinaryTemporalOperator

All Implemented Interfaces:

ILcdDataObject, ILcdGenericExpression, ILcdOGCCondition, ILcdCloneable, ILcdDeepCloneable, Cloneable
```
public final class TLcdOGCBinaryTemporalOperator
extends TLcdDataObject
implements ILcdOGCCondition
```
Filter 2.0 condition for temporal filtering.
You can use TLcdOGCFilterFactory.temporal(com.luciad.ogc.filter.model.TLcdOGCPropertyName, java.util.Date, javax.xml.namespace.QName) to easily create a temporal condition.

Note: serializing this operator to 1.1 OGC Filter XML (for example to SLD or WFS 1.x) will fail.

For a detailed description of the temporal operators see ISO 19108:2002, 5.2.3.5.

This operator supports the following time representations:
- TLcdGML32TimePosition
- Date
- String, only if formatted according the ISO 8601 specification (see TLcdISO8601DateFormat)
- Calendar
- Instant
- LocalDate
- LocalDateTime
- XMLGregorianCalendar
For time periods the following types are allowed:
- TLcdGML32TimePeriod
- ILcdTimeBounds
When encoding to XML, the types above are always translated into either a TLcdGML32TimePeriod or TLcdGML32TimePosition, according to specification.
When an unsupported type is used, the evaluation of this operator will always return false.
Since:

2017.0

Field Summary

Fields
Modifier and Type	Field and Description
`static QName`	`AFTER` The time associated with the property lies fully after the time associated with the expression.
`static QName`	`ANY_INTERACTS` Any interaction between the property and expression time.
`static QName`	`BEFORE` The time associated with the property lies fully before the time associated with the expression.
`static QName`	`BEGINS` The begin time of the property is equal to the begin time of the expression and the end time of the property is in the expression time period.
`static QName`	`BEGUN_BY` The begin time the property is equal to the begin time of the expression.
`static QName`	`DURING` The property time must be between the begin and end time of the expression time period.
`static QName`	`ENDED_BY` The end time of the property is equal to the end time of the expression and the begin time of the property is before the expression begin time.
`static QName`	`ENDS` The begin time of the property is after the begin time of the expression and the end times are equal.
`static QName`	`MEETS` The end time of the property is equal to the expression begin time.
`static QName`	`MET_BY` The begin time of the property is equal to the end time of the expression.
`static QName`	`OVERLAPPED_BY` The begin time of the property is in the expression time period and the end time of the property is after the end time of the expression.
`static QName`	`T_CONTAINS` The expression time is fully contained in the property time period.
`static QName`	`T_EQUALS` The property and expression time are equal.
`static QName`	`T_OVERLAPS` The begin time of the property is before the begin time of the expression and the end time of the property is in the expression time period.

Constructor Summary

Constructors
Constructor and Description
`TLcdOGCBinaryTemporalOperator()` Creates a new, empty operator.
`TLcdOGCBinaryTemporalOperator(TLcdOGCPropertyName aPropertyName, QName aType, Object aExpression)` Creates a new operator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`getExpression()` Gets the expression to be considered in the temporal relationship.
`ILcdOGCExpression`	`getPropertyName()` Gets the property name that identifies the time property to be considered in the temporal relationship.
`QName`	`getType()` Returns the value of the property that holds the type of this instance.
`int`	`hashCode()`
`void`	`setExpression(Object aExpression)` Sets the expression to be considered in the temporal relationship.
`void`	`setPropertyName(TLcdOGCPropertyName aPropertyName)` Sets the property name that identifies the time property to be considered in the temporal relationship.
`void`	`setType(QName aValue)` Sets the value of the property that holds the type of this instance.
`String`	`toString()`

Methods inherited from class com.luciad.datamodel.TLcdDataObject
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ENDED_BY
```
public static final QName ENDED_BY
```
    The end time of the property is equal to the end time of the expression and the begin time of the property is before the expression begin time. The property must be a time period.
  - BEFORE
```
public static final QName BEFORE
```
    The time associated with the property lies fully before the time associated with the expression.
  - AFTER
```
public static final QName AFTER
```
    The time associated with the property lies fully after the time associated with the expression.
  - BEGUN_BY
```
public static final QName BEGUN_BY
```
    The begin time the property is equal to the begin time of the expression. The expression must be a time period.
  - OVERLAPPED_BY
```
public static final QName OVERLAPPED_BY
```
    The begin time of the property is in the expression time period and the end time of the property is after the end time of the expression. The property and expression must both be a time period to use this operator.
  - T_EQUALS
```
public static final QName T_EQUALS
```
    The property and expression time are equal.
  - ANY_INTERACTS
```
public static final QName ANY_INTERACTS
```
    Any interaction between the property and expression time.
  - MEETS
```
public static final QName MEETS
```
    The end time of the property is equal to the expression begin time. Both the property and expression must be a time period.
  - MET_BY
```
public static final QName MET_BY
```
    The begin time of the property is equal to the end time of the expression. Both the property and expression must be a time period.
  - ENDS
```
public static final QName ENDS
```
    The begin time of the property is after the begin time of the expression and the end times are equal. Both the property and expression must be a time period.
  - T_OVERLAPS
```
public static final QName T_OVERLAPS
```
    The begin time of the property is before the begin time of the expression and the end time of the property is in the expression time period. Both the property and expression must be a time period.
  - T_CONTAINS
```
public static final QName T_CONTAINS
```
    The expression time is fully contained in the property time period. The property must be a time period.
  - BEGINS
```
public static final QName BEGINS
```
    The begin time of the property is equal to the begin time of the expression and the end time of the property is in the expression time period. The expression must be a time period.
  - DURING
```
public static final QName DURING
```
    The property time must be between the begin and end time of the expression time period. The expression must be a time period.
- Constructor Detail
  - TLcdOGCBinaryTemporalOperator
```
public TLcdOGCBinaryTemporalOperator()
```
    Creates a new, empty operator.
    Please use the self-contained constructor instead.
    If you do use this constructor, you must configure this operator using setPropertyName(com.luciad.ogc.filter.model.TLcdOGCPropertyName), setType(javax.xml.namespace.QName) and setExpression(java.lang.Object).
  - TLcdOGCBinaryTemporalOperator
```
public TLcdOGCBinaryTemporalOperator(TLcdOGCPropertyName aPropertyName,
                                     QName aType,
                                     Object aExpression)
```
    Creates a new operator.
    
    Parameters:
    
    aPropertyName - The property to compare
    
    aType - The type of comparison, see for example AFTER
    
    aExpression - The value to compare with, see class javadoc for possible types.
- Method Detail
  - getPropertyName
```
public ILcdOGCExpression getPropertyName()
```
    Gets the property name that identifies the time property to be considered in the temporal relationship.
    
    Returns:
    
    the property name that identifies the time property to be considered in the temporal relationship.
  - setPropertyName
```
public void setPropertyName(TLcdOGCPropertyName aPropertyName)
```
    Sets the property name that identifies the time property to be considered in the temporal relationship.
    
    Parameters:
    
    aPropertyName - the property name that identifies the time property to be considered in the temporal relationship.
  - getExpression
```
public Object getExpression()
```
    Gets the expression to be considered in the temporal relationship.
    For the possible types of this expression, see class javadoc/
    
    Returns:
    
    the expression to consider in the temporal relationship
  - setExpression
```
public void setExpression(Object aExpression)
```
    Sets the expression to be considered in the temporal relationship.
    For the possible types of this expression, see class javadoc/
    
    Parameters:
    
    aExpression - expression to be considered in the temporal relationship
  - getType
```
public QName getType()
```
    Returns the value of the property that holds the type of this instance.
    The possible values for this property are the public QName constants defined in this class.
    
    Returns:
    
    the type of comparison.
  - setType
```
public void setType(QName aValue)
```
    Sets the value of the property that holds the type of this instance.
    The possible values for this property are the public QName constants defined in this class.
    
    Parameters:
    
    aValue - the value to set.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class TLcdDataObject

LuciadLightspeedClass TLcdOGCBinaryTemporalOperator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

ENDED_BY

BEFORE

AFTER

BEGUN_BY

OVERLAPPED_BY

T_EQUALS

ANY_INTERACTS

MEETS

MET_BY

ENDS

T_OVERLAPS

T_CONTAINS

BEGINS

DURING

Constructor Detail

TLcdOGCBinaryTemporalOperator

TLcdOGCBinaryTemporalOperator

Method Detail

getPropertyName

setPropertyName

getExpression

setExpression

getType

setType

equals

hashCode

toString