be.SIRAPRISE.client.jsba

Class IndexAttribute

java.lang.Object

be.SIRAPRISE.client.jsba.AbstractDBObject

be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

be.SIRAPRISE.client.jsba.IndexAttribute

All Implemented Interfaces:

DBObject, UpdatableDBObject

@Relvars(relvarNames="INDEXATTRIBUTE")
public final class IndexAttribute
extends AbstractUpdatableDBObject

Author:

Erwin

Constructor Summary

Constructors

Constructor and Description
IndexAttribute() Creates the IndexComponent
IndexAttribute(java.lang.String relvarName, java.lang.String recordTypeName, int ordinal, java.lang.String expression) Creates the IndexComponent

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeName() Gets expression
int	getOrdinal() Gets ordinal
UpdatableDBObject	getPreUpdateState() Gets The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.
java.lang.String	getRecordTypeName() Gets recordTypeName
java.lang.String	getRelvarName() Gets relvarName
void	setAttributeName(java.lang.String attributeName) Sets attributeName
void	setAttributeName(ValueBuffer attributeName) Sets attributeName
void	setOrdinal(int ordinal) Sets ordinal
void	setOrdinal(ValueBuffer ordinal) Sets ordinal
void	setPreUpdateState() This method is called by the J/R bridging engine after an object has been setup from some tuple retrieved from the database.
void	setRecordTypeName(java.lang.String recordTypeName) Sets recordTypeName
void	setRecordTypeName(ValueBuffer recordTypeName) Sets recordTypeName
void	setRelvarName(java.lang.String relvarName) Sets relvarName
void	setRelvarName(ValueBuffer relvarName) Sets relvarName

Methods inherited from class be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

dbUpdateCommand, dbUpdateCommand, dbUpdateCommand

Methods inherited from class be.SIRAPRISE.client.jsba.AbstractDBObject

dbAddCommand, dbAddCommand, dbAddCommand, dbAddCommandAll, dbAssertCommand, dbAssertCommand, dbAssertCommand, dbAssertCommandAll, dbDeleteCommand, dbDeleteCommand, dbDeleteCommand, dbDeleteCommandAll, dbUnAssertCommand, dbUnAssertCommand, dbUnAssertCommand, dbUnAssertCommandAll

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexAttribute

public IndexAttribute()

Creates the IndexComponent

IndexAttribute

public IndexAttribute(java.lang.String relvarName,
                      java.lang.String recordTypeName,
                      int ordinal,
                      java.lang.String expression)

Creates the IndexComponent

Parameters:

relvarName - -

recordTypeName - -

ordinal - -

expression - -

Method Detail

getAttributeName

@GetterMethod(attributeDefs=@AttributeDef(attributeName="ATTRIBUTENAME",requiresEscaping=false,typeName="NAME"),
              relvarNames="INDEXATTRIBUTE")
public final java.lang.String getAttributeName()

Gets expression

Returns:

expression.

getOrdinal

@GetterMethod(attributeDefs=@AttributeDef(attributeName="ORDINAL",requiresEscaping=false,typeName="INT"),
              relvarNames="INDEXATTRIBUTE")
public final int getOrdinal()

Gets ordinal

Returns:

ordinal.

getPreUpdateState

public UpdatableDBObject getPreUpdateState()

Description copied from interface: UpdatableDBObject

Gets The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.

Returns:

The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.

getRecordTypeName

@GetterMethod(attributeDefs=@AttributeDef(attributeName="RECORDTYPENAME",requiresEscaping=false,typeName="NAME"),
              relvarNames="INDEXATTRIBUTE")
public final java.lang.String getRecordTypeName()

Gets recordTypeName

Returns:

recordTypeName.

getRelvarName

@GetterMethod(attributeDefs=@AttributeDef(attributeName="RELVARNAME",requiresEscaping=false,typeName="NAME"),
              relvarNames="INDEXATTRIBUTE")
public final java.lang.String getRelvarName()

Gets relvarName

Returns:

relvarName.

setAttributeName

public final void setAttributeName(java.lang.String attributeName)

Sets attributeName

Parameters:

attributeName - The attributeName to set.

setAttributeName

@AttributeDef(attributeName="ATTRIBUTENAME",
              requiresEscaping=false,
              typeName="NAME")
public final void setAttributeName(ValueBuffer attributeName)

Sets attributeName

Parameters:

attributeName - The attributeName to set.

setOrdinal

public final void setOrdinal(int ordinal)

Sets ordinal

Parameters:

ordinal - The ordinal to set.

setOrdinal

@AttributeDef(attributeName="ORDINAL",
              requiresEscaping=false,
              typeName="INT")
public final void setOrdinal(ValueBuffer ordinal)

Sets ordinal

Parameters:

ordinal - The ordinal to set.

setPreUpdateState

public final void setPreUpdateState()

Description copied from interface: UpdatableDBObject

This method is called by the J/R bridging engine after an object has been setup from some tuple retrieved from the database. The method must cause the object to save a copy (/clone) of all the fields that are pertinent to the database. This copy will be retrieved by the J/R bridging engine using the getPreUpdateState() method call, and will subsequently be used by the J/R bridging engine to determine which fields have changed value, and thus to determine which attributes need to be updated in the database.

setRecordTypeName

public final void setRecordTypeName(java.lang.String recordTypeName)

Sets recordTypeName

Parameters:

recordTypeName - The recordTypeName to set.

setRecordTypeName

@AttributeDef(attributeName="RECORDTYPENAME",
              requiresEscaping=false,
              typeName="NAME")
public final void setRecordTypeName(ValueBuffer recordTypeName)

Sets recordTypeName

Parameters:

recordTypeName - The recordTypeName to set.

setRelvarName

public final void setRelvarName(java.lang.String relvarName)

Sets relvarName

Parameters:

relvarName - The relvarName to set.

setRelvarName

@AttributeDef(attributeName="RELVARNAME",
              requiresEscaping=false,
              typeName="NAME")
public final void setRelvarName(ValueBuffer relvarName)

Sets relvarName

Parameters:

relvarName - The relvarName to set.