org.datanucleus.store.mapped.mapping
Class IndexMapping

java.lang.Object
  org.datanucleus.store.mapped.mapping.JavaTypeMapping
      org.datanucleus.store.mapped.mapping.SingleFieldMapping
          org.datanucleus.store.mapped.mapping.IndexMapping

public final class IndexMapping
extends SingleFieldMapping

Mapping for Index Columns. This class is for internal use only. It should not be used in user mappings nor extended.

Field Summary

Fields inherited from class org.datanucleus.store.mapped.mapping.JavaTypeMapping

datastoreContainer, datastoreMappings, LOCALISER, mmd, referenceMapping, roleForMember, storeMgr, type

Constructor Summary

IndexMapping()

Method Summary

java.lang.Class	getJavaType() Accessor for the type represented here, returning the class itself
java.lang.Object	getSampleValue(ClassLoaderResolver clr) Accessor for a sample value for this field
boolean	includeInFetchStatement() Accessor for whether to include this column in any fetch statement
ScalarExpression	newLiteral(QueryExpression qs, java.lang.Object value) Accessor for a new literal for this mapping.
ScalarExpression	newScalarExpression(QueryExpression qs, LogicSetExpression te) Accessor for a new literal for this mapping.

Methods inherited from class org.datanucleus.store.mapped.mapping.SingleFieldMapping

equals, getBoolean, getByte, getChar, getDefaultLength, getDouble, getFloat, getInt, getJavaTypeForDatastoreMapping, getLong, getObject, getShort, getString, getValidValues, initialize, prepareDatastoreMapping, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setShort, setString

Methods inherited from class org.datanucleus.store.mapped.mapping.JavaTypeMapping

addDatastoreMapping, failureMessage, getColumnMetaDataForMember, getDatastoreContainer, getDatastoreMapping, getDatastoreMappings, getMemberMetaData, getNumberOfDatastoreMappings, getObject, getReferenceMapping, getRoleForMember, getType, getValueForDatastoreMapping, hashCode, hasSimpleDatastoreRepresentation, includeInInsertStatement, includeInUpdateStatement, initialize, isNullable, isSerialised, setDatastoreContainer, setDefault, setMemberMetaData, setObject, setReferenceMapping, setRoleForMember

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexMapping

public IndexMapping()

Method Detail

getSampleValue

public java.lang.Object getSampleValue(ClassLoaderResolver clr)

Accessor for a sample value for this field

Overrides:

getSampleValue in class JavaTypeMapping

Parameters:

clr - ClassLoader resolver

Returns:

Sample field value

includeInFetchStatement

public boolean includeInFetchStatement()

Accessor for whether to include this column in any fetch statement

Overrides:

includeInFetchStatement in class JavaTypeMapping

Returns:

Whether to include the column when fetching.

getJavaType

public java.lang.Class getJavaType()

Accessor for the type represented here, returning the class itself

Specified by:

getJavaType in class JavaTypeMapping

Returns:

This class.

newLiteral

public ScalarExpression newLiteral(QueryExpression qs,
                                   java.lang.Object value)

Accessor for a new literal for this mapping.

Overrides:

newLiteral in class JavaTypeMapping

Parameters:

qs - The QueryStatement

value - The value of the object

Returns:

The new literal

newScalarExpression

public ScalarExpression newScalarExpression(QueryExpression qs,
                                            LogicSetExpression te)

Accessor for a new literal for this mapping.

Overrides:

newScalarExpression in class JavaTypeMapping

Parameters:

qs - The QueryStatement

te - The table Expression

Returns:

The new literal