org.tigris.scarab.om
Class BaseAttributeType

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BaseAttributeType

All Implemented Interfaces:

org.apache.torque.om.Persistent, org.apache.fulcrum.intake.Retrievable, java.io.Serializable

Direct Known Subclasses:

AttributeType

public abstract class BaseAttributeType

extends org.apache.torque.om.BaseObject

implements org.apache.fulcrum.intake.Retrievable

You should not use this class directly. It should not even be extended all references should be to AttributeType

See Also:

Serialized Form

Field Summary

protected java.util.List

collAttributes Collection to store aggregation of collAttributes

Fields inherited from class org.apache.torque.om.BaseObject

NEW_ID

Constructor Summary

BaseAttributeType()

Method Summary

void	addAttribute(Attribute l) Method called to associate a Attribute object to this object through the Attribute foreign key attribute
AttributeType	copy() Makes a copy of this object.
protected AttributeType	copyInto(AttributeType copyObj)
AttributeClass	getAttributeClass() Returns the associated AttributeClass object.
AttributeClass	getAttributeClass(java.sql.Connection connection) Return the associated AttributeClass object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.util.List	getAttributes() If this collection has already been initialized, returns the collection.
java.util.List	getAttributes(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getAttributes(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getAttributes(org.apache.torque.util.Criteria criteria, java.sql.Connection con) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getAttributesJoinAttributeOption(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getAttributesJoinAttributeType(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getAttributesJoinScarabUserImpl(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.Integer	getAttributeTypeId() Get the AttributeTypeId
java.lang.Object	getByName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPeerName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPosition(int pos) Retrieves a field from the object by Position as specified in the xml schema.
java.lang.Integer	getClassId() Get the ClassId
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.String	getJavaClassName() Get the JavaClassName
java.lang.String	getName() Get the Name
AttributeTypePeer	getPeer() returns a peer instance associated with this om.
org.apache.torque.om.ObjectKey	getPrimaryKey() returns an id that differentiates this object from others of its class.
java.lang.String	getQueryKey() get an id that differentiates this object from others of its class.
java.lang.String	getValidationKey() Get the ValidationKey
protected void	initAttributes() Temporary storage of collAttributes to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected boolean	isCacheOnSave() Specify whether to cache the object after saving to the db.
void	save() Stores the object in the database.
void	save(java.sql.Connection con) Stores the object in the database.
void	save(java.lang.String dbName) Stores the object in the database.
void	setAttributeClass(AttributeClass v) Declares an association between this object and a AttributeClass object
void	setAttributeClassKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setAttributeTypeId(java.lang.Integer v) Set the value of AttributeTypeId
void	setClassId(java.lang.Integer v) Set the value of ClassId
void	setJavaClassName(java.lang.String v) Set the value of JavaClassName
void	setName(java.lang.String v) Set the value of Name
void	setPrimaryKey(org.apache.torque.om.ObjectKey key) Set the PrimaryKey using ObjectKey.
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
void	setQueryKey(java.lang.String key) set an id that differentiates this object from others of its class.
void	setValidationKey(java.lang.String v) Set the value of ValidationKey
java.lang.String	toString()

Methods inherited from class org.apache.torque.om.BaseObject

equals, equals, getLog, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey

Methods inherited from class java.lang.Object

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

Field Detail

collAttributes

protected java.util.List collAttributes

Collection to store aggregation of collAttributes

Constructor Detail

BaseAttributeType

public BaseAttributeType()

Method Detail

getAttributeTypeId

public java.lang.Integer getAttributeTypeId()

Get the AttributeTypeId

Returns:

Integer

setAttributeTypeId

public void setAttributeTypeId(java.lang.Integer v)
                        throws org.apache.torque.TorqueException

Set the value of AttributeTypeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getClassId

public java.lang.Integer getClassId()

Get the ClassId

Returns:

Integer

setClassId

public void setClassId(java.lang.Integer v)
                throws org.apache.torque.TorqueException

Set the value of ClassId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getName

public java.lang.String getName()

Get the Name

Returns:

String

setName

public void setName(java.lang.String v)

Set the value of Name

Parameters:

v - new value

getJavaClassName

public java.lang.String getJavaClassName()

Get the JavaClassName

Returns:

String

setJavaClassName

public void setJavaClassName(java.lang.String v)

Set the value of JavaClassName

Parameters:

v - new value

getValidationKey

public java.lang.String getValidationKey()

Get the ValidationKey

Returns:

String

setValidationKey

public void setValidationKey(java.lang.String v)

Set the value of ValidationKey

Parameters:

v - new value

setAttributeClass

public void setAttributeClass(AttributeClass v)
                       throws org.apache.torque.TorqueException

Declares an association between this object and a AttributeClass object

Parameters:

v - AttributeClass

Throws:

org.apache.torque.TorqueException

getAttributeClass

public AttributeClass getAttributeClass()
                                 throws org.apache.torque.TorqueException

Returns the associated AttributeClass object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated AttributeClass object

Throws:

org.apache.torque.TorqueException

getAttributeClass

public AttributeClass getAttributeClass(java.sql.Connection connection)
                                 throws org.apache.torque.TorqueException

Return the associated AttributeClass object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated AttributeClass object

Throws:

org.apache.torque.TorqueException

setAttributeClassKey

public void setAttributeClassKey(org.apache.torque.om.ObjectKey key)
                          throws org.apache.torque.TorqueException

Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

initAttributes

protected void initAttributes()

Temporary storage of collAttributes to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.

addAttribute

public void addAttribute(Attribute l)
                  throws org.apache.torque.TorqueException

Method called to associate a Attribute object to this object through the Attribute foreign key attribute

Parameters:

l - Attribute

Throws:

org.apache.torque.TorqueException

getAttributes

public java.util.List getAttributes()
                             throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getAttributes(new Criteria())

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getAttributes

public java.util.List getAttributes(org.apache.torque.util.Criteria criteria)
                             throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this AttributeType has previously been saved, it will retrieve related Attributes from storage. If this AttributeType is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

Throws:

org.apache.torque.TorqueException

getAttributes

public java.util.List getAttributes(java.sql.Connection con)
                             throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getAttributes(new Criteria(),Connection) This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getAttributes

public java.util.List getAttributes(org.apache.torque.util.Criteria criteria,
                                    java.sql.Connection con)
                             throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this AttributeType has previously been saved, it will retrieve related Attributes from storage. If this AttributeType is new, it will return an empty collection or the current collection, the criteria is ignored on a new object. This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getAttributesJoinAttributeType

protected java.util.List getAttributesJoinAttributeType(org.apache.torque.util.Criteria criteria)
                                                 throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this AttributeType is new, it will return an empty collection; or if this AttributeType has previously been saved, it will retrieve related Attributes from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in AttributeType.

Throws:

org.apache.torque.TorqueException

getAttributesJoinAttributeOption

protected java.util.List getAttributesJoinAttributeOption(org.apache.torque.util.Criteria criteria)
                                                   throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this AttributeType is new, it will return an empty collection; or if this AttributeType has previously been saved, it will retrieve related Attributes from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in AttributeType.

Throws:

org.apache.torque.TorqueException

getAttributesJoinScarabUserImpl

protected java.util.List getAttributesJoinScarabUserImpl(org.apache.torque.util.Criteria criteria)
                                                  throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this AttributeType is new, it will return an empty collection; or if this AttributeType has previously been saved, it will retrieve related Attributes from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in AttributeType.

Throws:

org.apache.torque.TorqueException

getFieldNames

public static java.util.List getFieldNames()

Generate a list of field names.

Returns:

a list of field names

getByName

public java.lang.Object getByName(java.lang.String name)

Retrieves a field from the object by name passed in as a String.

Parameters:

name - field name

Returns:

value

getByPeerName

public java.lang.Object getByPeerName(java.lang.String name)

Retrieves a field from the object by name passed in as a String. The String must be one of the static Strings defined in this Class' Peer.

Parameters:

name - peer name

Returns:

value

getByPosition

public java.lang.Object getByPosition(int pos)

Retrieves a field from the object by Position as specified in the xml schema. Zero-based.

Parameters:

pos - position in xml schema

Returns:

value

save

public void save()
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed.

Specified by:

save in interface org.apache.torque.om.Persistent

Throws:

org.apache.torque.TorqueException

save

public void save(java.lang.String dbName)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. Note: this code is here because the method body is auto-generated conditionally and therefore needs to be in this file instead of in the super class, BaseObject.

Specified by:

save in interface org.apache.torque.om.Persistent

Parameters:

dbName -

Throws:

org.apache.torque.TorqueException

save

public void save(java.sql.Connection con)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. This method is meant to be used as part of a transaction, otherwise use the save() method and the connection details will be handled internally

Specified by:

save in interface org.apache.torque.om.Persistent

Parameters:

con -

Throws:

org.apache.torque.TorqueException

isCacheOnSave

protected boolean isCacheOnSave()

Specify whether to cache the object after saving to the db. This method returns true

setPrimaryKey

public void setPrimaryKey(org.apache.torque.om.ObjectKey key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using ObjectKey.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Parameters:

key - attributeTypeId ObjectKey

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(java.lang.String key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using a String.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Parameters:

key -

Throws:

org.apache.torque.TorqueException

getPrimaryKey

public org.apache.torque.om.ObjectKey getPrimaryKey()

returns an id that differentiates this object from others of its class.

Specified by:

getPrimaryKey in interface org.apache.torque.om.Persistent

getQueryKey

public java.lang.String getQueryKey()

get an id that differentiates this object from others of its class.

Specified by:

getQueryKey in interface org.apache.fulcrum.intake.Retrievable

setQueryKey

public void setQueryKey(java.lang.String key)
                 throws org.apache.torque.TorqueException

set an id that differentiates this object from others of its class.

Specified by:

setQueryKey in interface org.apache.fulcrum.intake.Retrievable

Throws:

org.apache.torque.TorqueException

copy

public AttributeType copy()
                   throws org.apache.torque.TorqueException

Makes a copy of this object. It creates a new object filling in the simple attributes. It then fills all the association collections and sets the related objects to isNew=true.

Throws:

org.apache.torque.TorqueException

copyInto

protected AttributeType copyInto(AttributeType copyObj)
                          throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

public AttributeTypePeer getPeer()

returns a peer instance associated with this om. Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior.

toString

public java.lang.String toString()