TLcdOGCResourceId (LuciadLightspeed API documentation)

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

All Implemented Interfaces:

ILcdDataObject, ILcdGenericExpression, ILcdOGCCondition, ILcdCloneable, ILcdDeepCloneable, Cloneable
```
public final class TLcdOGCResourceId
extends TLcdDataObject
implements ILcdOGCCondition
```
This class represents an OGC Filter 2.0 resource ID.

You should use this in combination with a TLcdOGCResourceIdsOperator, see also TLcdOGCFilterFactory.resourceIds(String...).

When evaluating a condition with resource IDs, the evaluator will compare the rid with the object's ID, defined by a ILcdOGCFeatureIDRetriever (typically through TLcdPrimaryKeyAnnotation). The version and date properties are ignored.

When serialized to an OGC Filter 1.1 (for example WFS 1), the resource ID condition is translated to object IDs on the filter.

Since:

2017.0

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`END_DATE_PROPERTY` Data property that maps to the `endDate` attribute.
`static TLcdDataProperty`	`PREVIOUS_RID_PROPERTY` Data property that maps to the `previousRid` attribute.
`static TLcdDataProperty`	`RID_PROPERTY` Data property that maps to the `rid` attribute.
`static TLcdDataProperty`	`START_DATE_PROPERTY` Data property that maps to the `startDate` attribute.
`static TLcdDataProperty`	`VERSION_PROPERTY` Data property that maps to the `version` attribute.

Constructor Summary

Constructors
Constructor and Description

TLcdOGCResourceId()
Create a new, empty resource ID.

TLcdOGCResourceId(String aID)
Create a new resource ID for the given ID.

Constructors
Constructor and Description
`TLcdOGCResourceId()` Create a new, empty resource ID.
`TLcdOGCResourceId(String aID)` Create a new resource ID for the given ID.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`XMLGregorianCalendar`	`getEndDate()` Returns the value of the property that maps to the `endDate` attribute.
`String`	`getPreviousRid()` Returns the value of the property that maps to the `previousRid` attribute.
`String`	`getRid()` Returns the value of the property that maps to the `rid` attribute.
`XMLGregorianCalendar`	`getStartDate()` Returns the value of the property that maps to the `startDate` attribute.
`Object`	`getVersion()` Returns the value of the property that maps to the `version` attribute.
`int`	`hashCode()`
`void`	`setEndDate(XMLGregorianCalendar aValue)` Sets the value of the property that maps to the `endDate` attribute.
`void`	`setPreviousRid(String aValue)` Sets the value of the property that maps to the `previousRid` attribute.
`void`	`setRid(String aValue)` Sets the value of the property that maps to the `rid` attribute.
`void`	`setStartDate(XMLGregorianCalendar aValue)` Sets the value of the property that maps to the `startDate` attribute.
`void`	`setVersion(Object aValue)` Sets the value of the property that maps to the `version` attribute.

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

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

- Field Detail
  - END_DATE_PROPERTY
```
public static final TLcdDataProperty END_DATE_PROPERTY
```
    Data property that maps to the endDate attribute. The possible values for this property are instances of javax.xml.datatype.XMLGregorianCalendar.
  - PREVIOUS_RID_PROPERTY
```
public static final TLcdDataProperty PREVIOUS_RID_PROPERTY
```
    Data property that maps to the previousRid attribute. The possible values for this property are instances of java.lang.String.
  - RID_PROPERTY
```
public static final TLcdDataProperty RID_PROPERTY
```
    Data property that maps to the rid attribute. The possible values for this property are instances of java.lang.String.
  - START_DATE_PROPERTY
```
public static final TLcdDataProperty START_DATE_PROPERTY
```
    Data property that maps to the startDate attribute. The possible values for this property are instances of javax.xml.datatype.XMLGregorianCalendar.
  - VERSION_PROPERTY
```
public static final TLcdDataProperty VERSION_PROPERTY
```
    Data property that maps to the version attribute. The possible values for this property are instances of
    - java.lang.String: one of "FIRST", "LAST", "PREVIOUS", "NEXT", "ALL"
    - long
    - javax.xml.datatype.XMLGregorianCalendar
- Constructor Detail
  - TLcdOGCResourceId
```
public TLcdOGCResourceId()
```
    Create a new, empty resource ID.
    Prefer the self-contained TLcdOGCResourceId(String) instead. If not, be sure to use setRid(String) to initialize your instance properly.
  - TLcdOGCResourceId
```
public TLcdOGCResourceId(String aID)
```
    Create a new resource ID for the given ID.
    
    Parameters:
    
    aID - The ID.
- Method Detail
  - getEndDate
```
public XMLGregorianCalendar getEndDate()
```
    Returns the value of the property that maps to the endDate attribute.
    
    Returns:
    
    the value of the END_DATE_PROPERTY property.
  - setEndDate
```
public void setEndDate(XMLGregorianCalendar aValue)
```
    Sets the value of the property that maps to the endDate attribute.
    
    Parameters:
    
    aValue - the value to set for the END_DATE_PROPERTY property.
  - getPreviousRid
```
public String getPreviousRid()
```
    Returns the value of the property that maps to the previousRid attribute.
    
    Returns:
    
    the value of the PREVIOUS_RID_PROPERTY property.
  - setPreviousRid
```
public void setPreviousRid(String aValue)
```
    Sets the value of the property that maps to the previousRid attribute.
    
    Parameters:
    
    aValue - the value to set for the PREVIOUS_RID_PROPERTY property.
  - getRid
```
public String getRid()
```
    Returns the value of the property that maps to the rid attribute.
    
    Returns:
    
    the value of the RID_PROPERTY property.
  - setRid
```
public void setRid(String aValue)
```
    Sets the value of the property that maps to the rid attribute.
    
    Parameters:
    
    aValue - the value to set for the RID_PROPERTY property.
  - getStartDate
```
public XMLGregorianCalendar getStartDate()
```
    Returns the value of the property that maps to the startDate attribute.
    
    Returns:
    
    the value of the START_DATE_PROPERTY property.
  - setStartDate
```
public void setStartDate(XMLGregorianCalendar aValue)
```
    Sets the value of the property that maps to the startDate attribute.
    
    Parameters:
    
    aValue - the value to set for the START_DATE_PROPERTY property.
  - getVersion
```
public Object getVersion()
```
    Returns the value of the property that maps to the version attribute.
    The possible values for this property are instances of
    - java.lang.String: one of "FIRST", "LAST", "PREVIOUS", "NEXT", "ALL"
    - long
    - javax.xml.datatype.XMLGregorianCalendar
    Returns:
    
    the value of the VERSION_PROPERTY property.
  - setVersion
```
public void setVersion(Object aValue)
```
    Sets the value of the property that maps to the version attribute.
    The possible values for this property are instances of
    - java.lang.String: one of "FIRST", "LAST", "PREVIOUS", "NEXT", "ALL".
    - long
    - javax.xml.datatype.XMLGregorianCalendar
    Parameters:
    
    aValue - the value to set for the VERSION_PROPERTY property.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

LuciadLightspeedClass TLcdOGCResourceId

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

END_DATE_PROPERTY

PREVIOUS_RID_PROPERTY

RID_PROPERTY

START_DATE_PROPERTY

VERSION_PROPERTY

Constructor Detail

TLcdOGCResourceId

TLcdOGCResourceId

Method Detail

getEndDate

setEndDate

getPreviousRid

setPreviousRid

getRid

setRid

getStartDate

setStartDate

getVersion

setVersion

equals

hashCode