| org.tigris.scarab.om.BaseAttributeType
All known Subclasses: org.tigris.scarab.om.AttributeType,
BaseAttributeType | abstract public class BaseAttributeType extends BaseObject implements org.apache.fulcrum.intake.Retrievable(Code) | | You should not use this class directly. It should not even be
extended all references should be to AttributeType
|
Method Summary | |
public void | addAttribute(Attribute l) | public AttributeType | copy() Makes a copy of this object. | protected AttributeType | copyInto(AttributeType copyObj) | public AttributeClass | getAttributeClass() Returns the associated AttributeClass object. | public AttributeClass | getAttributeClass(Connection connection) | public Integer | getAttributeTypeId() | public List | getAttributes() If this collection has already been initialized, returns
the collection. | public List | getAttributes(Criteria criteria) If this collection has already been initialized with
an identical criteria, it returns the collection. | public List | getAttributes(Connection con) If this collection has already been initialized, returns
the collection. | public List | getAttributes(Criteria criteria, Connection con) If this collection has already been initialized with
an identical criteria, it returns the collection. | protected List | getAttributesJoinAttributeOption(Criteria criteria) 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. | protected List | getAttributesJoinAttributeType(Criteria criteria) 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. | protected List | getAttributesJoinScarabUserImpl(Criteria criteria) 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. | public Object | getByName(String name) Retrieves a field from the object by name passed in as a String. | public Object | getByPeerName(String name) Retrieves a field from the object by name passed in
as a String. | public Object | getByPosition(int pos) Retrieves a field from the object by Position as specified
in the xml schema. | public Integer | getClassId() | public static synchronized List | getFieldNames() Generate a list of field names. | public String | getJavaClassName() | public String | getName() | public AttributeTypePeer | getPeer() returns a peer instance associated with this om. | public ObjectKey | getPrimaryKey() returns an id that differentiates this object from others
of its class. | public String | getQueryKey() get an id that differentiates this object from others
of its class. | public String | getValidationKey() | 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. | public void | save() Stores the object in the database. | public void | save(String dbName) Stores the object in the database. | public void | save(Connection con) Stores the object in the database. | public void | setAttributeClass(AttributeClass v) | public void | setAttributeClassKey(ObjectKey key) | public void | setAttributeTypeId(Integer v) | public void | setClassId(Integer v) | public void | setJavaClassName(String v) | public void | setName(String v) | public void | setPrimaryKey(ObjectKey key) Set the PrimaryKey using ObjectKey. | public void | setPrimaryKey(String key) Set the PrimaryKey using a String. | public void | setQueryKey(String key) set an id that differentiates this object from others
of its class. | public void | setValidationKey(String v) | public String | toString() |
collAttributes | protected List collAttributes(Code) | | Collection to store aggregation of collAttributes
|
addAttribute | public void addAttribute(Attribute l) throws TorqueException(Code) | | Method called to associate a Attribute object to this object
through the Attribute foreign key attribute
Parameters: l - Attribute throws: TorqueException - |
copy | public AttributeType copy() throws TorqueException(Code) | | 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.
|
getAttributeClass | public AttributeClass getAttributeClass() throws TorqueException(Code) | | Returns the associated AttributeClass object.
If it was not retrieved before, the object is retrieved from
the database
the associated AttributeClass object throws: TorqueException - |
getAttributeClass | public AttributeClass getAttributeClass(Connection connection) throws TorqueException(Code) | | 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 objectfrom the database, if it was not retrieved before the associated AttributeClass object throws: TorqueException - |
getAttributeTypeId | public Integer getAttributeTypeId()(Code) | | Get the AttributeTypeId
Integer |
getAttributes | public List getAttributes() throws TorqueException(Code) | | If this collection has already been initialized, returns
the collection. Otherwise returns the results of
getAttributes(new Criteria())
the collection of associated objects throws: TorqueException - |
getAttributes | public List getAttributes(Criteria criteria) throws TorqueException(Code) | | 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: TorqueException - |
getAttributes | public List getAttributes(Connection con) throws TorqueException(Code) | | 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
|
getAttributes | public List getAttributes(Criteria criteria, Connection con) throws TorqueException(Code) | | 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
|
getAttributesJoinAttributeOption | protected List getAttributesJoinAttributeOption(Criteria criteria) throws TorqueException(Code) | | 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.
|
getAttributesJoinAttributeType | protected List getAttributesJoinAttributeType(Criteria criteria) throws TorqueException(Code) | | 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.
|
getAttributesJoinScarabUserImpl | protected List getAttributesJoinScarabUserImpl(Criteria criteria) throws TorqueException(Code) | | 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.
|
getByName | public Object getByName(String name)(Code) | | Retrieves a field from the object by name passed in as a String.
Parameters: name - field name value |
getByPeerName | public Object getByPeerName(String name)(Code) | | 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 value |
getByPosition | public Object getByPosition(int pos)(Code) | | Retrieves a field from the object by Position as specified
in the xml schema. Zero-based.
Parameters: pos - position in xml schema value |
getClassId | public Integer getClassId()(Code) | | Get the ClassId
Integer |
getFieldNames | public static synchronized List getFieldNames()(Code) | | Generate a list of field names.
a list of field names |
getJavaClassName | public String getJavaClassName()(Code) | | Get the JavaClassName
String |
getPeer | public AttributeTypePeer getPeer()(Code) | | 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.
|
getPrimaryKey | public ObjectKey getPrimaryKey()(Code) | | returns an id that differentiates this object from others
of its class.
|
getQueryKey | public String getQueryKey()(Code) | | get an id that differentiates this object from others
of its class.
|
getValidationKey | public String getValidationKey()(Code) | | Get the ValidationKey
String |
initAttributes | protected void initAttributes()(Code) | | 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.
|
isCacheOnSave | protected boolean isCacheOnSave()(Code) | | Specify whether to cache the object after saving to the db.
This method returns true
|
save | public void save() throws TorqueException(Code) | | Stores the object in the database. If the object is new,
it inserts it; otherwise an update is performed.
throws: TorqueException - |
save | public void save(String dbName) throws TorqueException(Code) | | 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.
Parameters: dbName - throws: TorqueException - |
save | public void save(Connection con) throws TorqueException(Code) | | 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
Parameters: con - throws: TorqueException - |
setAttributeClass | public void setAttributeClass(AttributeClass v) throws TorqueException(Code) | | Declares an association between this object and a AttributeClass object
Parameters: v - AttributeClass throws: TorqueException - |
setAttributeClassKey | public void setAttributeClassKey(ObjectKey key) throws TorqueException(Code) | | Provides convenient way to set a relationship based on a
ObjectKey, for example
bar.setFooKey(foo.getPrimaryKey())
|
setAttributeTypeId | public void setAttributeTypeId(Integer v) throws TorqueException(Code) | | Set the value of AttributeTypeId
Parameters: v - new value |
setClassId | public void setClassId(Integer v) throws TorqueException(Code) | | Set the value of ClassId
Parameters: v - new value |
setJavaClassName | public void setJavaClassName(String v)(Code) | | Set the value of JavaClassName
Parameters: v - new value |
setName | public void setName(String v)(Code) | | Set the value of Name
Parameters: v - new value |
setPrimaryKey | public void setPrimaryKey(ObjectKey key) throws TorqueException(Code) | | Set the PrimaryKey using ObjectKey.
Parameters: key - attributeTypeId ObjectKey |
setPrimaryKey | public void setPrimaryKey(String key) throws TorqueException(Code) | | Set the PrimaryKey using a String.
Parameters: key - |
setQueryKey | public void setQueryKey(String key) throws TorqueException(Code) | | set an id that differentiates this object from others
of its class.
|
setValidationKey | public void setValidationKey(String v)(Code) | | Set the value of ValidationKey
Parameters: v - new value |
|
|