GetObjectId (OpenJPA Parent POM 2.4.0 API)

java.lang.Object
- org.apache.openjpa.jdbc.kernel.exps.AbstractVal
- - org.apache.openjpa.jdbc.kernel.exps.GetObjectId

All Implemented Interfaces:

Serializable, Val, Value
```
 class GetObjectId
extends AbstractVal
```
Select the oid value of an object; typically used in projections.

Author:

Abe White

Field Summary
- Fields inherited from class org.apache.openjpa.jdbc.kernel.exps.AbstractVal
  FALSE, TRUE
- Fields inherited from interface org.apache.openjpa.jdbc.kernel.exps.Val
  ABS_VAL, ARGS_VAL, CMP_EQUAL, COALESCE_VAL, CONCAT_VAL, FORCE_OUTER, GENERALCASE_VAL, INDEXOF_VAL, JOIN_REL, LENGTH_VAL, LOCATE_VAL, LOWER_VAL, MATH_VAL, NULL_CMP, NULLIF_VAL, SIMPLECASE_VAL, SQRT_VAL, SUBSTRING_VAL, TRIM_VAL, UPPER_VAL, VAL, WHENCONDITION_VAL, WHENSCALAR_VAL

Constructor Summary

Constructors
Constructor and Description

GetObjectId(PCPath path)
Constructor.

Constructors
Constructor and Description
`GetObjectId(PCPath path)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acceptVisit(ExpressionVisitor visitor)` Accept a visit from a tree visitor.
`void`	`appendTo(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql, int index)` Append the `index`th SQL element to the given buffer.
`void`	`calculateValue(Select sel, ExpContext ctx, ExpState state, Val other, ExpState otherState)` Calculate and cache the SQL for this value.
`Column[]`	`getColumns(ExpState state)` Return the oid columns.
`ClassMetaData`	`getMetaData()` Return any associated persistent type.
`Class`	`getType()` Return the expected type for this value, or `Object` if the type is unknown.
`void`	`groupBy(Select sel, ExpContext ctx, ExpState state)` Group by this value.
`ExpState`	`initialize(Select sel, ExpContext ctx, int flags)` Initialize the value.
`int`	`length(Select sel, ExpContext ctx, ExpState state)` Return the number of SQL elements in this value.
`Object`	`load(ExpContext ctx, ExpState state, Result res)` Load the data for this value.
`void`	`orderBy(Select sel, ExpContext ctx, ExpState state, boolean asc)` Order by this value.
`void`	`select(Select sel, ExpContext ctx, ExpState state, boolean pks)` Select the data for this value.
`void`	`selectColumns(Select sel, ExpContext ctx, ExpState state, boolean pks)` Select just the columns for this value.
`void`	`setImplicitType(Class type)` Set the implicit type of the value, based on how it is used in the filter.
`void`	`setMetaData(ClassMetaData meta)` Associate a persistent type with this value.
`Object`	`toDataStoreValue(Select sel, ExpContext ctx, ExpState state, Object val)` Return the datastore value of the given object in the context of this value.

Methods inherited from class org.apache.openjpa.jdbc.kernel.exps.AbstractVal
appendIndex, appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendSize, appendType, getAlias, getId, getName, getPath, getSelectAs, isAggregate, isVariable, isXPath, setAlias

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- GetObjectId
```
public GetObjectId(PCPath path)
```
  Constructor. Provide the value whose oid to extract.

Method Detail

getColumns

public Column[] getColumns(ExpState state)

Return the oid columns.

getMetaData
```
public ClassMetaData getMetaData()
```
Description copied from interface: Value

Return any associated persistent type.

setMetaData
```
public void setMetaData(ClassMetaData meta)
```
Description copied from interface: Value

Associate a persistent type with this value.

getType
```
public Class getType()
```
Description copied from interface: Value

Return the expected type for this value, or Object if the type is unknown.

setImplicitType
```
public void setImplicitType(Class type)
```
Description copied from interface: Value

Set the implicit type of the value, based on how it is used in the filter. This method is only called on values who return Object from Value.getType().