public class CollectionDescriptor extends ObjectReferenceDescriptor
MetadataManager
).CASCADE_LINK, CASCADE_NONE, CASCADE_OBJECT
_NEXT, ACCEPT_LOCKS, ACCESS, ATTRIBUTE, ATTRIBUTE_NAME, ATTRIBUTE_VALUE, AUTO_DELETE, AUTO_INCREMENT, AUTO_RETRIEVE, AUTO_UPDATE, BATCH_MODE, CASCADE_LINK_STR, CASCADE_NONE_STR, CASCADE_OBJECT_STR, CLASS_DESCRIPTOR, CLASS_EXTENT, CLASS_NAME, CLASS_PROXY, CLASS_REF, COLLECTION_CLASS, COLLECTION_DESCRIPTOR, COLUMN_NAME, CON_LOG_ABANDONED, CON_MAX_ACTIVE, CON_MAX_IDLE, CON_MAX_WAIT, CON_MIN_EVICTABLE_IDLE_TIME_MILLIS, CON_NUM_TESTS_PER_EVICTION_RUN, CON_REMOVE_ABANDONED, CON_REMOVE_ABANDONED_TIMEOUT, CON_TEST_ON_BORROW, CON_TEST_ON_RETURN, CON_TEST_WHILE_IDLE, CON_TIME_BETWEEN_EVICTION_RUNS_MILLIS, CON_WHEN_EXHAUSTED_ACTION, CONNECTION_FACTORY, CONNECTION_POOL, CONSTANT_ARGUMENT, DATASOURCE_NAME, DBMS_NAME, DEFAULT_CONNECTION, DELETE_PROCEDURE, DOCUMENTATION, DRIVER_NAME, EAGER_RELEASE, EXTENDS, FACTORY_CLASS, FACTORY_METHOD, FIELD_CONVERSION, FIELD_DESCRIPTOR, FIELD_ID_REF, FIELD_NAME, FIELD_REF, FK_POINTING_TO_ITEMS_CLASS, FK_POINTING_TO_THIS_CLASS, FOREIGN_KEY, ID, IGNORE_AUTOCOMMIT_EXCEPTION, INCLUDE_ALL_FIELDS, INCLUDE_PK_FIELDS_ONLY, INDEX_COLUMN, INDEX_DESCRIPTOR, INDEXED, INDIRECTION_TABLE, INITIALIZATION_METHOD, INSERT_PROCEDURE, INVERSE_FK, ISOLATION_LEVEL, ITEMS_CLASS, JCD_ALIAS, JDBC_CONNECTION_DESCRIPTOR, JDBC_LEVEL, JDBC_TYPE, LENGTH, LOCKING, MAPPING_REPOSITORY, NAME, NULLABLE, OBJECT_CACHE, ORDERBY, OTM_DEPENDENT, PRECISION, PRIMARY_KEY, PROXY_PREFETCHING_LIMIT, PROXY_REFERENCE, QUERY_CUSTOMIZER, REFERENCE_DESCRIPTOR, REFERENCED_CLASS, REFRESH, REPOSITORY_VERSION, RETURN, RETURN_FIELD_REF, ROW_READER, RUNTIME_ARGUMENT, SCALE, SCHEMA_NAME, SEQUENCE_MANAGER, SEQUENCE_MANAGER_CLASS, SEQUENCE_NAME, SORT, TABLE_NAME, TAG_ACCESS, TAG_ACCESS_ANONYMOUS, TAG_ACCESS_READONLY, TAG_ACCESS_READWRITE, TAG_SUPER, UNIQUE, UPDATE_LOCK, UPDATE_PROCEDURE, URL_DBALIAS, URL_PROTOCOL, URL_SUBPROTOCOL, USE_AUTOCOMMIT, USER_NAME, USER_PASSWD, VALIDATION_QUERY, VALUE
Constructor and Description |
---|
CollectionDescriptor(ClassDescriptor descriptor) |
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
Store the specified attribute and it's value.
|
void |
addFkToItemClass(java.lang.String column)
add a FK column pointing to the item Class
|
void |
addFkToThisClass(java.lang.String column)
add a FK column pointing to This Class
|
void |
addOrderBy(java.lang.String fieldName,
boolean sortAscending)
Adds a field for orderBy
|
java.lang.String |
getAttribute(java.lang.String attributeName)
Get the value of an attribute
|
java.lang.String |
getAttribute(java.lang.String attributeName,
java.lang.String defaultValue)
Get the value of an attribute
|
java.lang.String[] |
getAttributeNames()
Returns an array of the names of all atributes of this descriptor.
|
java.util.Map |
getAttributes()
Returns the attribute map (name, value) of this descriptor.
|
java.lang.Class |
getCollectionClass()
returns the type of the collection.
|
java.lang.String |
getCollectionClassName()
Retrieve the classname of the collection.
|
java.lang.String[] |
getFksToItemClass() |
java.lang.String[] |
getFksToThisClass() |
java.lang.String |
getIndirectionTable() |
java.util.Collection |
getOrderBy()
Returns the orderby Collection of Fields.
|
QueryCustomizer |
getQueryCustomizer() |
boolean |
hasProxyItems() |
boolean |
isMtoNRelation() |
void |
setCollectionClass(java.lang.Class c)
set the type of the collection
|
void |
setFksToItemClass(java.util.Vector fksToItemClass) |
void |
setFksToThisClass(java.util.Vector fksToThisClass) |
void |
setIndirectionTable(java.lang.String indirectionTable) |
void |
setQueryCustomizer(QueryCustomizer queryCustomizer)
Sets the queryCustomizer.
|
java.lang.String |
toXML()
returns the XML marshalled version of this instance.
|
addForeignKeyField, addForeignKeyField, getCascadeAsString, getCascadeDelete, getCascadeRetrieve, getCascadeStore, getCascadingDelete, getCascadingStore, getForeignKeyFieldDescriptors, getForeignKeyFields, getForeignKeyValues, getItemClass, getItemClassName, getItemProxyClass, getOtmDependent, getProxyPrefetchingLimit, hasConstraint, isLazy, isRefresh, isSuperReferenceDescriptor, setCascadeDelete, setCascadeRetrieve, setCascadeStore, setCascadingDelete, setCascadingDelete, setCascadingStore, setCascadingStore, setConstraint, setForeignKeyFields, setItemClass, setLazy, setOtmDependent, setProxyPrefetchingLimit, setRefresh, toString
getAttributeName, getClassDescriptor, getPersistentField, setClassDescriptor, setPersistentField, setPersistentField
public CollectionDescriptor(ClassDescriptor descriptor)
public java.lang.String[] getFksToThisClass()
public void setFksToThisClass(java.util.Vector fksToThisClass)
public void addFkToThisClass(java.lang.String column)
public void addFkToItemClass(java.lang.String column)
public java.lang.Class getCollectionClass()
public void setCollectionClass(java.lang.Class c)
c
- the collection typepublic java.lang.String getCollectionClassName()
public java.lang.String getIndirectionTable()
public void setIndirectionTable(java.lang.String indirectionTable)
public java.lang.String[] getFksToItemClass()
public void setFksToItemClass(java.util.Vector fksToItemClass)
public boolean isMtoNRelation()
public void addOrderBy(java.lang.String fieldName, boolean sortAscending)
fieldName
- The field name to be usedsortAscending
- true for ASCENDING, false for DESCENDINGpublic java.util.Collection getOrderBy()
public java.lang.String toXML()
XmlCapable
toXML
in interface XmlCapable
toXML
in class ObjectReferenceDescriptor
public QueryCustomizer getQueryCustomizer()
public void setQueryCustomizer(QueryCustomizer queryCustomizer)
queryCustomizer
- The queryCustomizer to setpublic boolean hasProxyItems() throws PersistenceBrokerException
PersistenceBrokerException
public void addAttribute(java.lang.String attributeName, java.lang.String attributeValue)
AttributeContainer
addAttribute
in interface AttributeContainer
attributeName
- the name of the attribute to retrieveattributeValue
- the attribute's valueAttributeContainer.addAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName, java.lang.String defaultValue)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrievedefaultValue
- the value to return if the attribute is not presentAttributeContainer.getAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrieveAttributeContainer.getAttribute(String)
public java.util.Map getAttributes()
public java.lang.String[] getAttributeNames()
null
)(C) 2002 - 2005 Apache Software Foundation
All rights reserved. Published under the Apache License 2.0.
http://db.apache.org/ojb
Version: 1.0.4, 2005-12-30