be.SIRAPRISE.client.jsba

Class Attribute

java.lang.Object

be.SIRAPRISE.client.jsba.AbstractDBObject

be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject

be.SIRAPRISE.client.jsba.Attribute

All Implemented Interfaces:

DBObject, UpdatableDBObject

@Relvars(relvarNames={"ATTRIBUTE","ATTRIBUTELENGTHCONSTRAINT"})
public final class Attribute
extends AbstractUpdatableDBObject

Author:

Erwin Smout

Constructor Summary

Constructors

Constructor and Description
Attribute() Creates an empty Attribute
Attribute(java.lang.String attributeName, java.lang.String typeName, int maximumLength) Creates the Attribute

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeName() Gets The attribute name
int	getMaximumLength() Gets The logical length, or -1 if this doen't apply
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	getTypeName() Gets The type name
void	setAttributeName(java.lang.String attributeName) Sets The attribute name
void	setAttributeName(ValueBuffer attributeName) Sets The attribute name
void	setMaximumLength(int maximumLength) Sets The maximumLength
void	setMaximumLength(ValueBuffer maximumLength) Sets The maximumLength
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	setTypeName(java.lang.String typeName) Sets The type name
void	setTypeName(ValueBuffer typeName) Sets The type name

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

Attribute

public Attribute()

Creates an empty Attribute

Attribute

public Attribute(java.lang.String attributeName,
                 java.lang.String typeName,
                 int maximumLength)

Creates the Attribute

Parameters:

attributeName - The attribute name

typeName - The type name

maximumLength - The logical length, or -1 if not applicable or unknown or irrelevant

Method Detail

getAttributeName

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

Gets The attribute name

Returns:

The attribute name.

getMaximumLength

@GetterMethod(relvarNames="ATTRIBUTELENGTHCONSTRAINT",
              attributeDefs=@AttributeDef(attributeName="MAXIMUMLENGTH",requiresEscaping=false,typeName="INT"))
public final int getMaximumLength()

Gets The logical length, or -1 if this doen't apply

Returns:

The logical length, or -1 if this doen't apply

getPreUpdateState

public final 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.

getTypeName

@GetterMethod(relvarNames="ATTRIBUTE",
              attributeDefs=@AttributeDef(attributeName="TYPENAME",requiresEscaping=false,typeName="NAME"))
public final java.lang.String getTypeName()

Gets The type name

Returns:

The type name.

setAttributeName

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

Sets The attribute name

Parameters:

attributeName - The attributeName to set.

setAttributeName

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

Sets The attribute name

Parameters:

attributeName - The attributeName to set.

setMaximumLength

public final void setMaximumLength(int maximumLength)

Sets The maximumLength

Parameters:

maximumLength - The maximumLength to set.

setMaximumLength

@AttributeDef(attributeName="MAXIMUMLENGTH",
              requiresEscaping=false,
              typeName="INT")
public final void setMaximumLength(ValueBuffer maximumLength)

Sets The maximumLength

Parameters:

maximumLength - The maximumLength 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.

setTypeName

public final void setTypeName(java.lang.String typeName)

Sets The type name

Parameters:

typeName - The typeName to set.

setTypeName

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

Sets The type name

Parameters:

typeName - The typeName to set.