|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.repository.ItemDescriptorImpl atg.adapter.gsa.GSAItemDescriptor
public class GSAItemDescriptor
An ItemDescriptor which defines a kind of item in a GSARepository. A GSARepository can have one or more of these.
GSARepository
,
Serialized FormNested Class Summary | |
---|---|
static class |
GSAItemDescriptor.DirectSqlResult
|
static class |
GSAItemDescriptor.ItemRefList
|
static class |
GSAItemDescriptor.PropIdRef
|
Field Summary | |
---|---|
static java.lang.String |
CACHE_MODE_DISABLED
|
static java.lang.String |
CACHE_MODE_DISTRIBUTED
|
static java.lang.String |
CACHE_MODE_DISTRIBUTED_JMS
|
static java.lang.String |
CACHE_MODE_LOCKED
|
static java.lang.String |
CACHE_MODE_SIMPLE
|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.repository.ItemDescriptorImpl |
---|
mPropertyDescriptors, mPropertyDescriptorTable, mPropertyNames |
Fields inherited from interface atg.adapter.gsa.Constants |
---|
ATTR_CASCADE_DELETE_ORDER, ATTR_CSW_PROPERTIES, ATTR_CSW_QUERIES, ATTR_DEFAULT_UNCACHED_ITEM_QUERIES, ATTR_LAZY_ITEM_LOADING, ATTR_SPLIT_QUERIES, ATTR_TEXT_HANDLE_COLUMN, ATTR_TEXT_INDEX_TABLE, ATTR_UPDATE_LAST_MODIFIED, CASCADE_DELETE_AFTER_AUX_BEFORE_PRI, CASCADE_DELETE_FIRST, CASCADE_DELETE_LAST, CASCADE_DELETE_ORDER_NAMES, DEFAULT_EVENT_SERVER, DEFAULT_INVALIDATOR_SERVICE, ERR_ADD_MISSING_PROPERTIES, ERR_ADD_NON_TRANSIENT, ERR_ARGS_FOR_NON_PARAMETER_QUERY, ERR_BAD_EVENT_DATA, ERR_BAD_TABLE, ERR_CIRCULAR_REFERENCE, ERR_CLASS_NOT_FOUND, ERR_COLLECTION_LOAD_ID, ERR_COMPARE_MULTI, ERR_COMPARE_NONCOMPARABLE, ERR_CONTENT_PROPERTIES_NOT_DEFINED, ERR_COULD_NOT_UNSUBSCRIBE, ERR_DEPENDENT_PROP_NOT_EXISTS, ERR_DEPENDENT_PROP_NULL, ERR_DS_PREPARE, ERR_DS_SWITCH, ERR_EXC_COLLECTION_LOAD_FULL, ERR_EXC_COLLECTION_LOAD_SINGLE, ERR_FOLDER_PROPERTIES_NOT_DEFINED, ERR_HANDLING_INVALIDATE_CACHE_ENTRY, ERR_ID_SPACE_CONFIGURATION, ERR_ILLEGAL_PARAM_TYPE, ERR_INITIALIZING_ID_GENERATOR, ERR_INVALID_COMPARISON_QUERY, ERR_INVALID_DATA_TYPE_NAME, ERR_INVALID_ITEM, ERR_INVALID_ITEM_DESCRIPTOR_NAME, ERR_INVALID_KEY, ERR_INVALID_KEY_ELEMENT, ERR_INVALID_KEY_ENCODING, ERR_INVALID_KEY_VALUES, ERR_INVALID_LIST_INDEX, ERR_INVALID_PATTERNMATCH_QUERY, ERR_INVALID_PROPERTY, ERR_INVALID_QUERY, ERR_INVALID_QUERY_ELEMENT, ERR_INVALID_TEXT_SEARCH_QUERY, ERR_INVALID_TM_DS_COMBO, ERR_ITEM_NOT_EXIST, ERR_LOAD_COLUMN_INFO, ERR_MISSING_ID_SPACE, ERR_NO_ARGS_FOR_QUERY, ERR_NO_DATABASE_TABLE_INFO, ERR_NO_DATATYPE_FOR_PROPERTY, ERR_NO_DB2_HANDLE, ERR_NO_DEFAULT_SEARCH_PROPERTIES, ERR_NO_EVENT_SERVER, ERR_NO_IDS, ERR_NO_LOWER_FUNCTION, ERR_NO_PARAMETER_EXPRESSION, ERR_NO_PARSER, ERR_NO_PRIMARY_TABLE, ERR_NO_SUB_PROPERTIES, ERR_NO_SUBSCRIBER_ITEM_DESCRIPTOR, ERR_NO_SYB_TEXT_INDEX, ERR_NO_TEMPLATE_FILES, ERR_NO_TRANSACTION, ERR_NO_TRANSIENT_QUERIES, ERR_NOT_DISTRIBUTED_MODE, ERR_NULL_ARGUMENT, ERR_NULL_ID, ERR_NULL_ITEM, ERR_NULL_QUERY_OPTIONS, ERR_PARSING_TEMPLATE, ERR_PROCEDURE_HELPER_INIT, ERR_PROPERTY_NOT_QUERYABLE, ERR_RETURN_PROP_NOT_EXISTS, ERR_RETURN_PROP_NOT_GSA, ERR_RETURN_PROP_NOT_READ, ERR_RETURN_PROP_NULL, ERR_RQL_FILTER, ERR_SQL_STRING_NULL, ERR_SUB_TYPE_PROPERTY_ON_NON_ROOT_TYPE, ERR_TABLE_KEY_UNMATCHED, ERR_TRANSACTION, ERR_TYPE_MATCHING, ERR_UNABLE_TO_READ_TEMPLATE_FILE, ERR_UNKNOWN_EVENT_TYPE, ERR_VERSION_PROPERTY_INVALID_TYPE, ERR_VIEW_IS_TRANSIENT, ERR_WRONG_NUMBER_ARGS_FOR_QUERY, FTS_LANG_DB2, FTS_LANG_MSSQL, FTS_LANG_MSSQL_INLINE, FTS_LANG_ORACLE, FTS_LANG_SYBASE, INFO_STARTUP_BEGIN, INFO_STARTUP_END, ISOLATION_LEVEL_NAMES, READ_COMMITTED, REPEATABLE_READ, REPOSITORY_COMPONENT_NAME, RESOURCE_BUNDLE_NAME, SERIALIZABLE, SUBSCRIBER_ADDRESS_PROPERTY, SUBSCRIBER_ITEM_DESCRIPTOR_NAME, SUBSCRIBER_ITEM_DESCRIPTOR_PROPERTY, SUBSCRIBER_PORT_PROPERTY, SUBSCRIBER_REPOSITORY_PROPERTY, WARN_PROBLEM_SENDING_EVENT, WARN_RETURN_PROP_MULTI, WARN_RETURN_PROP_TRANSIENT |
Constructor Summary | |
---|---|
GSAItemDescriptor(atg.adapter.gsa.GSARepository pRepository)
Creates a new item descriptor for the specified GSARepository. |
Method Summary | |
---|---|
void |
addCascadeDeleteProperty(RepositoryPropertyDescriptor pDesc)
|
void |
addCascadeInsertProperty(RepositoryPropertyDescriptor pDesc)
|
void |
addCascadeUpdateProperty(RepositoryPropertyDescriptor pDesc)
|
protected RepositoryItem |
addItem(atg.adapter.gsa.GSAItem pItem)
Insert an item into the repository, using the the specified property values. |
RepositoryItem |
addItemOnCommit(atg.adapter.gsa.GSAItem pItem)
Insert an item into the repository, using the the specified property values. |
void |
addManyToOneProperty(RepositoryPropertyDescriptor pDesc)
|
void |
addPropertiesChangedListener(PropertiesChangedListener pListener)
These events are all sent and managed by the root of the type hierarchy since they may affect all item types in this class tree. |
void |
addPropertyDescriptor(RepositoryPropertyDescriptor pPropertyDescriptor)
Adds the given property descriptor to the internal table of known descriptors |
protected void |
addReferencedItems(atg.adapter.gsa.GSAItem pItem,
RepositoryPropertyDescriptor[] pDescs)
Loops through all properties that have "cascade=update" set and adds the referenced items if they are not already there. |
void |
addTable(atg.adapter.gsa.Table pTable)
Adds a new table onto the list. |
void |
addTableInvalidationListeners()
Adds any table event listeners that need to be registered for all of the tables in this this item descriptor. |
protected void |
addTransientItem(atg.adapter.gsa.GSAItem pItem)
Add transient item to Item Transaction State |
GSAItemDescriptor |
addTypeDescriptorEntry(java.lang.Object pKey,
GSAItemDescriptor pValue)
Adds a new entry to the type descriptor table. |
boolean |
allowRemoveNullsUpdate(RepositoryItemImpl pItem)
Can we persist changes to multi-properties when removing null values via the removeNullValues property |
protected java.util.ArrayList |
applyRange(java.util.ArrayList pInitial,
int pStartIndex,
int pEndIndex)
Takes a list of returned items and applies a range operation to them. |
boolean |
areInstances(DynamicBeanInfo pBeanInfo)
Determine whether the specified BeanInfo is a
descendent of this object. |
boolean |
areInstances(GSAItemDescriptor pOtherDesc)
Determine whether the specified item descriptor is a descendent of this object. |
boolean |
checkForPersistentItem(atg.adapter.gsa.GSAId pId)
Check for the persistent item with the specified id from the database. |
void |
clearReferencesToItem(atg.adapter.gsa.GSAId pId,
RepositoryPropertyDescriptor[] pDescs)
Loops through all properties manyToOneProperties. |
protected void |
close(java.sql.Connection pConnection)
Close a DB connection, logging any SQLExceptions. |
protected void |
close(atg.adapter.gsa.GSATransaction pTr,
java.sql.Connection pConnection)
Close a DB connection, logging any SQLExceptions. |
protected void |
close(java.sql.ResultSet pResultSet)
Closes the ResultSet logging any Throwables. |
protected void |
close(java.sql.ResultSet pResultSet,
atg.adapter.gsa.SQLStatement pStatement,
java.sql.Connection pConnection)
Close DB objects, logging any SQLExceptions. |
protected void |
close(java.sql.ResultSet pResultSet,
atg.adapter.gsa.SQLStatement pStatement,
java.sql.Connection pConnection,
atg.adapter.gsa.GSATransaction pTransaction)
Close DB objects, logging any SQLExceptions. |
protected void |
close(atg.adapter.gsa.SQLStatement pStatement)
Close an SQLStatement logging any SQLExceptions. |
protected void |
close(java.sql.Statement pStatement)
Closes the Statement logging any Throwables. |
protected RepositoryItem[] |
collectReferencedItemsForRemoval(atg.adapter.gsa.GSAId pId,
RepositoryPropertyDescriptor[] pDescs)
Loops through all properties that have "cascade=delete" set and collects object for future removal. |
int |
compareTo(GSAItemDescriptor pOther)
Compare this item descriptor to another item descriptor. |
int |
compareTo(java.lang.Object pOther)
Compare this descriptor to another object. |
GSAPropertyDescriptor[] |
computeDefaultProperties()
Compute a starting value default properties. |
boolean |
containsDerivedSortProperties(SortDirectives pDirectives)
Determines if any of the given sort directives refers to a derived property |
protected void |
createReferencedItems(atg.adapter.gsa.GSAItem pItem,
RepositoryPropertyDescriptor[] pDescs)
Loops through all properties that have "cascade=insert" set and creates any new items necessary. |
protected java.util.Map |
createSizedMap(int pExpectedSize)
Create an appropriately sized Map. |
void |
debug(java.lang.String pMsg,
int pLevel)
|
boolean |
dependsOn(GSAItemDescriptor pDesc,
boolean pRequired)
Returns true if we have a reference from one of our property descriptors to the item-descriptor supplied (which may be of a different GSA repository). |
void |
disableItemCache()
Disable the item cache. |
void |
disableQueryCache()
Disable the query cache. |
java.lang.String |
dumpCaches()
Dump the caches for this item descriptor |
java.lang.String |
encodeCompositeKey(java.lang.String[] pIdValues)
Encode an array of ID values to be used as a Repository ID |
java.lang.Object[] |
evaluateRqlFilterParams()
Evaluates our current rql filter params and returns all evaluated values |
int |
executeCountQuery(Query pQuery)
Execute a query that returns the count of items that would be returned in the specifed query were executed. |
int |
executeCountQuery(Query pQuery,
java.lang.Object[] pParameterValues)
Execute a query that returns the count of items that would be returned in the specifed query were executed. |
atg.adapter.gsa.GSAItem[] |
executeDirectSqlQuery(atg.adapter.gsa.query.DirectSqlQuery pQuery,
int pStartingIndex,
int pEndingIndex,
SortDirectives pSortDirectives,
java.lang.Object[] pParameterValues,
QueryOptions pOptions)
Executes a direct sql query, which can contain user-defined returned properties and query dependencies |
atg.adapter.gsa.GSAItem[] |
executeQuery(Query pQuery,
int pStartingIndex,
int pEndingIndex,
SortDirectives pSortDirectives)
Execute the specified query and return the results. |
atg.adapter.gsa.GSAItem[] |
executeQuery(Query pQuery,
int pStartingIndex,
int pEndingIndex,
SortDirectives pSortDirectives,
java.lang.Object[] pParameterValues,
QueryOptions pOptions)
Execute the specified query and return the results. |
java.util.List |
executeSingleQuery(atg.adapter.gsa.query.Clause pClause,
SortDirectives pSortDirectives,
int pStartIndex,
int pEndIndex)
Execute a query and return the results. |
java.util.List |
executeSingleQuery(atg.adapter.gsa.query.Clause pClause,
SortDirectives pSortDirectives,
int pStartIndex,
int pEndIndex,
java.sql.Connection pConnection)
Execute a query and return the results. |
java.util.List |
executeSingleQuery(atg.adapter.gsa.query.Clause pClause,
SortDirectives pSortDirectives,
int pStartIndex,
int pEndIndex,
java.sql.Connection pConnection,
java.lang.Object[] pParameterValues,
atg.adapter.gsa.GSATransaction pTr,
QueryOptions pOptions)
Execute a query and return the results. |
protected static Query |
findNestedQuery(atg.adapter.gsa.query.CompoundQuery pCompoundQuery,
java.lang.Class pQueryType)
|
java.lang.String |
format(java.lang.String pMsgKey)
Utility for formatting messages with no arguments |
java.lang.String |
format(java.lang.String pMsgKey,
java.lang.Object pArg)
|
java.lang.String |
format(java.lang.String pMsgKey,
java.lang.Object[] pArgs)
Utility for formatting predefined messages using our respository's resource bundle |
java.lang.String |
format(java.lang.String pMsgKey,
java.lang.Object pArg1,
java.lang.Object pArg2)
|
java.lang.String |
generateDropSQL(atg.adapter.gsa.OutputSQLContext pSQLContext,
atg.adapter.gsa.DatabaseTableInfo pDTI)
Generate SQL to drop tables for this item descriptor |
atg.adapter.gsa.GSAId |
generateGSAId(atg.repository.CompositeKey pValue)
Generate a GSAId based on another composite key |
atg.adapter.gsa.GSAId |
generateGSAId(java.lang.Object pValue)
Generate a GSAId based on a single ID value |
atg.adapter.gsa.GSAId |
generateGSAId(java.lang.Object[] pValues)
Generate a GSAId based on an array of values |
atg.adapter.gsa.GSAId |
generateGSAId(java.lang.Object[] pValues,
boolean pRemoveNulls)
Generate a GSAId based on an array of values |
java.lang.String |
generateSQL(atg.adapter.gsa.OutputSQLContext pSQLContext,
atg.adapter.gsa.DatabaseTableInfo pDTI)
Generate SQL for this item descriptor |
java.lang.String |
generateSQL(atg.adapter.gsa.OutputSQLContext pSQLContext,
java.lang.String pDatabaseName)
Generate SQL for this item descriptor |
GSAItemDescriptor |
getBaseDescriptor()
|
Builder |
getBuilder()
Get our query builder as the right type. |
protected atg.adapter.gsa.GSAItem |
getCachedItem(java.lang.String pId)
Get an item from the cache, by id. |
java.util.List |
getCachedItemIds()
Get list of item ids from cache |
java.lang.String |
getCacheMode()
Returns property CacheMode |
boolean |
getCacheNullItems()
|
boolean |
getCacheSwitchLoadQueries()
Get property cacheSwitchLoadQueries |
int |
getCascadeDeleteOrder()
Get property cascadeDeleteOrder
This property controls when cascade delete operations are performed. |
RepositoryPropertyDescriptor[] |
getCascadeDeleteProperties()
|
RepositoryPropertyDescriptor[] |
getCascadeInsertProperties()
|
RepositoryPropertyDescriptor[] |
getCascadeUpdateProperties()
|
protected java.sql.Connection |
getConnection(atg.adapter.gsa.GSATransaction pTr)
Get a DB connection to use. |
RepositoryPropertyDescriptor |
getContentChecksumProperty()
|
RepositoryPropertyDescriptor |
getContentLengthProperty()
|
RepositoryPropertyDescriptor |
getContentNameProperty()
|
RepositoryPropertyDescriptor |
getContentPathProperty()
|
Query |
getContentPathQuery(java.lang.String pPath)
Returns a query to retrieve an item for a path. |
RepositoryPropertyDescriptor |
getContentProperty()
|
boolean |
getDefaultItemDescriptor()
Get property DefaultItemDescriptor. |
GSAPropertyDescriptor[] |
getDefaultProperties()
Get property defaultProperties |
GSAPropertyDescriptor[] |
getDefaultTextSearchProperties()
Get property defaultTextSearchProperties |
boolean |
getDefaultUncachedItemQueries()
|
java.util.List |
getDependencies(Query pQuery)
Generate query dependency list for this query used for query invalidation. |
java.lang.String |
getErrorCode()
Returns an error code if this item descriptor is not valid. |
atg.adapter.gsa.query.Clause |
getFilterQuery()
Get property filterQuery |
RepositoryPropertyDescriptor |
getFolderIdProperty()
|
GSAPropertyDescriptor |
getGSAPropertyDescriptor(java.lang.String pName)
Get a property descriptor as the right type |
atg.adapter.gsa.GSARepository |
getGSARepository()
Get our repository as the right type. |
atg.adapter.gsa.GSAView |
getGSARepositoryView()
Get our repository as the right type. |
protected atg.adapter.gsa.GSATransaction |
getGSATransaction()
Gets the current GSATransaction. |
boolean |
getHasCacheReferencesById()
|
int |
getId()
Get property Id |
atg.core.jdbc.ResultSetGetter[] |
getIdGetters()
Get property idGetter |
GSAPropertyDescriptor |
getIdProperty()
Get property idProperty |
atg.repository.query.IdQueryDependency |
getIdQueryDependency(Query pQuery,
GSAItemDescriptor pContext)
Get dependency for id query |
char |
getIdSeparator()
Get property IdSpearator |
java.lang.String[] |
getIdSpaceNames()
Get property idSpaceNames |
java.lang.Class[] |
getIdTypes()
Get property idTypes |
int |
getIsolationLevel()
|
atg.adapter.gsa.GSAItem |
getItem(atg.adapter.gsa.GSAId pId,
boolean pReadWrite)
Get the item of our type with the specified id |
RepositoryItem |
getItemByPath(java.lang.String pPath)
|
protected atg.adapter.gsa.ItemCache |
getItemCache()
Get the cache to use. |
int |
getItemCacheSize()
|
long |
getItemCacheTimeout()
|
RepositoryItemDescriptor |
getItemDescriptor(java.lang.String pName)
Returns a RepositoryItemDescriptor accessed with the given name. |
java.lang.String[] |
getItemDescriptorNames()
Returns an array of the names of all child item descriptors. |
java.lang.String |
getItemDisplayNameProperty()
Gets the property ItemDisplayNameProperty. |
long |
getItemExpireTimeout()
|
java.util.Map |
getItems(java.util.Collection pIds,
boolean pReadWrite)
Returns the items for the collection of ids supplied (including any transient items). |
protected java.util.Map |
getItems(java.util.Collection pIds,
boolean pReadWrite,
boolean pGetTransientItems)
Get the items of our type with the specified ids. |
RepositoryPropertyDescriptor |
getLastModifiedProperty()
|
GSAPropertyDescriptor |
getLastModifiedUpdateProperty()
|
int |
getLoadItemBatchSize()
Get property loadItemBatchSize |
ClientLockManager |
getLockManager()
|
long |
getLockTimeout()
|
RepositoryPropertyDescriptor[] |
getManyToOneProperties()
|
protected atg.adapter.gsa.GSAId |
getNewId()
Get a id suitable for creating items of this type. |
protected java.util.Map |
getNullItems()
Get the cache to use. |
protected atg.adapter.gsa.GSAItem |
getOrWaitForPersistentItem(atg.adapter.gsa.GSAId pId)
This method is the main access point for getting a persistent version of the item. |
GSAItemDescriptor |
getParentDescriptor()
Get property ParentDescriptor |
RepositoryItemDescriptor |
getParentItemDescriptor()
This method is in the RepositoryItemDescriptorContainer interface for accessing this information. |
protected atg.adapter.gsa.GSAItem |
getPersistentItem(atg.adapter.gsa.GSAId pId)
Load the persistent item with the specified id from the database. |
protected void |
getPersistentItems(java.util.List pIds,
java.util.Map pItems,
boolean pCacheResults)
Load the specified items from the DB into the passed in Map, optionally caching the items using a normal GSA transaction. |
protected void |
getPersistentItems(java.util.List pIds,
java.util.Map pItems,
java.sql.Connection pConnection,
boolean pCacheResults)
Load the specified items from the DB into the passed in Map, optionally caching the items. |
atg.adapter.gsa.Table |
getPrimaryTable()
|
DynamicPropertyDescriptor[] |
getPropertyDescriptors()
Returns the all PropertyDescriptors |
java.lang.String[] |
getPropertyNames()
Returns the list of the names of the known properties |
RepositoryPropertyDescriptor |
getRepositoryPropertyDescriptor(java.lang.String pPropertyName)
Returns the RepositoryPropertyDescriptor for the specified property. |
GSAItemDescriptor |
getRootDescriptor()
|
java.lang.Object[] |
getRqlFilterParameters()
Get property rqlFilterParameters |
java.lang.String |
getRqlFilterString()
Get property rqlFilterString |
boolean |
getSplitQueries()
Get property splitQueries
If true repository queries are split into pieces for SQL generation as
needed for correctness. |
protected boolean |
getStoreTransientItems()
|
boolean |
getStoreTransientItemsOnCommit()
|
GSAItemDescriptor[] |
getSubTypeDescriptors()
|
GSAPropertyDescriptor |
getSubTypeProperty()
|
java.lang.Object |
getSubTypeValue()
|
java.util.Set |
getSubTypeValues()
|
java.lang.String |
getSubTypeValueString()
|
GSAItemDescriptor |
getSuperTypeDescriptor()
|
atg.adapter.gsa.Table[] |
getTables()
|
protected atg.adapter.gsa.GSAItem |
getTransientItem(java.lang.String pId)
|
java.util.Map |
getTransientItems()
|
java.util.Map |
getTypeDescriptorMap()
|
java.lang.Object |
getTypeDescriptorMapKey(java.lang.Object pRawType)
Converts a raw type value which is stored in the database for a sub-type-property, to a type object, which is used as the key in the typeDescriptorMap. |
boolean |
getUseCacheForDelete()
Get property useCacheForDelete |
boolean |
getUseIdForPath()
|
atg.adapter.version.VersionItemDescriptor |
getVersionDescriptorWrapper()
Get property versionDescriptorWrapper |
RepositoryPropertyDescriptor |
getVersionProperty()
|
boolean |
hasCompositeKey()
Determine if this item type has a composite ID. |
void |
invalidateCachedItem(java.lang.String pId)
Invalidates any cached properties we may have for this item. |
void |
invalidateCaches()
Invalidates both the item and query caches for this item descriptor. |
void |
invalidateCaches(boolean pGlobal)
Invalidates both the item and query caches for this item descriptor. |
void |
invalidateItem(java.lang.String pId,
boolean pRemove)
For the case of distributed-cache mode operation, this is used to notify other subscribers that they may need to flush this item from their caches |
void |
invalidateItemCache()
Invalidates the item caches for this item descriptor. |
void |
invalidateItemCache(boolean pGlobal)
Invalidates both the item and query caches for this item descriptor. |
protected boolean |
isCachedNull(atg.adapter.gsa.GSAId pId)
|
boolean |
isCacheSwitchLoadQueries()
Test property cacheSwitchLoadQueries |
boolean |
isContent()
|
boolean |
isDefaultItemDescriptor()
Test property DefaultItemDescriptor |
boolean |
isDisabledCacheMode()
Returns true if property cacheMode equals CACHE_MODE_DISABLED, else false |
boolean |
isDistributedCacheMode()
Returns true if property cacheMode equals CACHE_MODE_DISTRIBUTED, else false |
boolean |
isDistributedJMSCacheMode()
Returns true if property cacheMode equals CACHE_MODE_DISTRIBUTED_JMS, else false |
boolean |
isFolder()
|
boolean |
isIdEqualsPath()
Sets the property IdEqualsPath property. |
boolean |
isInstance(java.lang.Object pObj)
If this item is from the GSA we then check the inheritance tree to see if the object is an instanceof of this item descriptor |
boolean |
isInstance(RepositoryItemDescriptor pDescriptor)
|
boolean |
isLockedCacheMode()
Returns true if property cacheMode equals CACHE_MODE_LOCKED, else false |
boolean |
isLoggingDebug()
|
boolean |
isLoggingError()
Get the loggingError property from our repository. |
boolean |
isLoggingWarning()
Get the loggingWarning property from our repository. |
boolean |
isSimpleCacheMode()
Returns true if property cacheMode equals CACHE_MODE_SIMPLE, else false |
boolean |
isSuperTypeDistributedCacheMode()
Returns true if property cacheMode of the superTypeDescriptor equals CACHE_MODE_DISTRIBUTED, else false |
boolean |
isUpdateTransactionWarningForNotMethodCalled()
Get property updateTransactionWarningForNotMethodCalled
if true ItemTransactionState will monitor whether a specific method
is called when items belong to this ItemDescriptor get updated. |
boolean |
isUseCacheForDelete()
Test property useCacheForDelete |
boolean |
isWritable()
|
void |
logDebug(java.lang.String pMsg)
Log a debug message through our repository. |
void |
logDebug(java.lang.Throwable pThrowable)
Log a debug exception through our repository. |
void |
logError(java.lang.String pMsg)
Log an error message through our repository. |
void |
logError(java.lang.String pMsg,
java.lang.Throwable pThrowable)
Log an error message through our repository including and exception |
void |
logError(java.lang.Throwable pThrowable)
Log an exception through our repository |
protected void |
logGetItem(java.lang.String pId,
boolean pReadWrite,
atg.adapter.gsa.GSAItem pItem,
java.lang.String pDetail)
Logs information from a getItem call |
void |
logWarning(java.lang.String pMsg)
Log an warning message through our repository. |
void |
logWarning(java.lang.String pMsg,
java.lang.Throwable pThrowable)
Log an warning message through our repository including and exception |
void |
logWarning(java.lang.Throwable pThrowable)
Log an exception through our repository |
void |
markItemAsRemoved(atg.adapter.gsa.GSAId pId)
Marks this item as being removed in this transaction. |
void |
markItemAsRemoved(atg.adapter.gsa.GSAId pId,
boolean pSendDelete)
Marks this item as being removed in this transaction. |
void |
putCurrentProperty(atg.adapter.gsa.GSAItem pItem,
RepositoryPropertyDescriptor pProperty,
java.lang.Object pValue)
Put the specified property directly into the specifed item's current properties. |
protected void |
putNullItemInCache(atg.adapter.gsa.GSAId pId)
|
void |
removeItem(atg.adapter.gsa.GSAId pId,
boolean pRemoveReferences)
Removes the item from the permanent repository data store. |
void |
removeItemFromCache(java.lang.String pId)
Removes the specified item from all repository caches. |
void |
removeItemFromCache(java.lang.String pId,
boolean pGlobal)
Removes the specified item from all repository caches. |
void |
removeItemFromCache(java.lang.String pId,
boolean pGlobal,
boolean pRemoveTransientProperties)
Removes the specified item from all repository caches. |
protected void |
removeNullItem(atg.adapter.gsa.GSAId pId)
|
void |
removePropertiesChangedListener(PropertiesChangedListener pListener)
Removes a properties changed event listener from this item descriptor. |
void |
removePropertyDescriptor(java.lang.String pPropertyName)
Removes the given property descriptor from the internal table of known descriptors |
void |
removeReferencedItems(atg.adapter.gsa.GSAId pId,
RepositoryPropertyDescriptor[] pDescs)
Loops through all properties that have "cascade=delete" set and removes the referenced items. |
protected void |
removeReferencedItems(RepositoryItem[] pItems)
Removes the items in the array of references. |
void |
removeTableInvalidationListeners()
Removes any table event listeners that are registered |
protected java.lang.Object |
removeTransientItem(java.lang.String pId)
|
protected void |
rollback()
Mark the current transaction to be rolled back. |
void |
sendGSAEvent(atg.adapter.gsa.event.GSAEvent pEvent)
/** Sends an event to the subscribers for this item-descriptor. |
void |
sendPropertiesChangedEvent(atg.repository.RepositoryChangedItem pItem,
int pType,
java.util.Map pProperties)
We cannot be synchronized on the item-descriptor when this method is called or we'll deadlock due to the TableInvalidationListener logic which gets called synchronously from one of these listeners. |
void |
sendPropertiesChangedEvent(java.lang.String pId,
int pType,
java.util.Map pProperties)
We cannot be synchronized on the item-descriptor when this method is called or we'll deadlock due to the TableInvalidationListener logic which gets called synchronously from one of these listeners. |
void |
setCacheMode(java.lang.String pCacheMode)
Sets property CacheMode |
void |
setCacheNullItems(boolean pCacheNullItems)
Sets the property CacheNullItems. |
void |
setCacheSwitchLoadQueries(boolean pCacheSwitchLoadQueries)
Set property cacheSwitchLoadQueries |
void |
setCascadeDeleteOrder(int pCascadeDeleteOrder)
Set property cascadeDeleteOrder |
void |
setContent(boolean pContent)
Sets the property Content. |
void |
setContentChecksumProperty(RepositoryPropertyDescriptor pContentChecksumProperty)
Sets the property ContentChecksumProperty. |
void |
setContentLengthProperty(RepositoryPropertyDescriptor pContentLengthProperty)
Sets the property ContentLengthProperty. |
void |
setContentNameProperty(RepositoryPropertyDescriptor pContentNameProperty)
Sets the property ContentNameProperty. |
void |
setContentPathProperty(RepositoryPropertyDescriptor pContentPathProperty)
Sets the property ContentPathProperty. |
void |
setContentProperty(RepositoryPropertyDescriptor pContentProperty)
Sets the property ContentProperty. |
void |
setDefaultProperties(GSAPropertyDescriptor[] pDefaultProperties)
Set property defaultProperties . |
void |
setDefaultTextSearchProperties(GSAPropertyDescriptor[] pDefaultTextSearchProperties)
Set property defaultTextSearchProperties |
void |
setDefaultUncachedItemQueries(boolean pDefaultUncachedItemQueries)
Sets the property DefaultUncachedItemQueries. |
void |
setFilterQuery(atg.adapter.gsa.query.Clause pFilterQuery)
Set property filterQuery |
void |
setFolderIdProperty(RepositoryPropertyDescriptor pFolderIdProperty)
Sets the property FolderIdProperty. |
void |
setHasCacheReferencesById(boolean pVal)
|
void |
setId(int pId)
Set property Id |
void |
setIdSeparator(char pValue)
Set property IdSeparator |
void |
setIdSpaceNames(java.lang.String[] pIdSpaceNames)
Set property idSpaceNames |
void |
setIsolationLevel(int pIsolationLevel)
Sets the property IsolationLevel. |
void |
setItemCacheSize(int pItemCacheSize)
Sets the property ItemCacheSize. |
void |
setItemCacheTimeout(long pItemCacheTimeout)
Sets the property ItemCacheTimeout. |
atg.adapter.gsa.GSAId |
setItemDescriptorType(atg.adapter.gsa.GSAId pGSAId,
java.lang.Object pType)
Set the item descriptor type to a GSAId based on the given value of the type column |
void |
setItemExpireTimeout(long pItemExpireTimeout)
Sets the property ItemExpireTimeout. |
void |
setLastModifiedProperty(RepositoryPropertyDescriptor pLastModifiedProperty)
Sets the property LastModifiedProperty. |
void |
setLastModifiedUpdateProperty(GSAPropertyDescriptor pLastModifiedProperty)
Sets the property LastModifiedUpdateProperty. |
void |
setLoadItemBatchSize(int pLoadItemBatchSize)
Set property loadItemBatchSize |
void |
setLoggingDebug(boolean pLoggingDebug)
Are we debugging this item type specifically? Returns true if logging debug is set on the repository or the item-descriptor. |
void |
setParentDescriptor(GSAItemDescriptor pParentDescriptor)
Set property ParentDescriptor |
void |
setPrimaryTable(atg.adapter.gsa.Table pPrimaryTable)
Sets the property primaryTable . |
void |
setPropertiesOnItem(atg.adapter.gsa.GSAItem pItem,
java.util.Map pPropertyToValueMap)
Sets the properties found in the propertyToValueMap on the given item. |
void |
setRqlFilterParameters(java.lang.Object[] pRqlFilterParameters)
Set property rqlFilterParameters |
void |
setRqlFilterString(java.lang.String pRqlFilterString)
Set property rqlFilterString . |
void |
setSplitQueries(boolean pSplitQueries)
Set property splitQueries |
void |
setStoreTransientItemsOnCommit(boolean storeOnCommitFlag)
|
void |
setSubTypeProperty(GSAPropertyDescriptor pSubTypeProperty)
Sets the property SubTypeProperty. |
void |
setSubTypeValue(java.lang.Object pSubTypeValue)
Sets the property SubTypeValue. |
void |
setSubTypeValueString(java.lang.String pSubTypeValueString)
Sets the property SubTypeValueString. |
void |
setSuperTypeDescriptor(GSAItemDescriptor pSuperTypeDescriptor)
Sets the property SuperTypeDescriptor. |
void |
setTypeDescriptorMap(java.util.Map pTypeDescriptorMap)
Sets the property TypeDescriptorMap. |
void |
setUpdateTransactionWarningForNotMethodCalled(boolean pUpdateTransactionWarningForNotMethodCalled)
Set property updateTransactionWarningForNotMethodCalled |
void |
setUseCacheForDelete(boolean pUseCacheForDelete)
Set property useCacheForDelete |
void |
setUseIdForPath(boolean pUseIdForPath)
Sets the property UseIdForPath. |
void |
setVersionDescriptorWrapper(atg.adapter.version.VersionItemDescriptor pWrapper)
Set property versionDescriptorWrapper |
void |
setVersionProperty(RepositoryPropertyDescriptor pVersionProperty)
Sets the property VersionProperty. |
void |
setWritable(boolean pWritable)
Sets the property Writable. |
protected void |
sort(java.util.List pItems,
SortDirectives pSortDirectives)
Sort the specified list of repository items according to the sort directives and collator specified. |
protected void |
storeTransientItem(atg.adapter.gsa.GSAItem pItem)
Store the transient item in a RAM (commited items/transactions only). |
atg.adapter.gsa.GSAId |
stringToRawId(java.lang.String pStringId)
Convert a String repository id to a raw repository id |
void |
subscribe()
Adds an entry for this item descriptor to the table of subscribers |
java.lang.String |
toString()
Get a string representation of this object. |
void |
unsubscribe()
Removes any entries for this item descriptor from the table of subscribers |
void |
updateItem(atg.adapter.gsa.GSAItem pItem)
Updates the item in the repository |
void |
updateItemDescriptor()
This method gets called when the parsing of the template has been completed. |
protected GSAItemDescriptor |
updateItemType(atg.adapter.gsa.GSAItem pItem)
Sets the item type to a dynamic type based on the subTypeProperty's current value. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_VERSION
public static final java.lang.String CACHE_MODE_DISABLED
public static final java.lang.String CACHE_MODE_SIMPLE
public static final java.lang.String CACHE_MODE_DISTRIBUTED
public static final java.lang.String CACHE_MODE_DISTRIBUTED_JMS
public static final java.lang.String CACHE_MODE_LOCKED
Constructor Detail |
---|
public GSAItemDescriptor(atg.adapter.gsa.GSARepository pRepository)
Method Detail |
---|
public void setId(int pId)
pId
- new value to setpublic int getId()
public void setIdSpaceNames(java.lang.String[] pIdSpaceNames)
idSpaceNames
pIdSpaceNames
- new value to setpublic java.lang.String[] getIdSpaceNames()
idSpaceNames
idSpaceNames
public void setItemCacheSize(int pItemCacheSize)
pItemCacheSize
- new value to setpublic int getItemCacheSize()
public void setItemCacheTimeout(long pItemCacheTimeout)
pItemCacheTimeout
- new value to set
java.lang.IllegalArgumentException
- if pItemCacheTimeout < 0public long getItemCacheTimeout()
public void setItemExpireTimeout(long pItemExpireTimeout)
pItemExpireTimeout
- new value to setpublic long getItemExpireTimeout()
public void setCacheSwitchLoadQueries(boolean pCacheSwitchLoadQueries)
cacheSwitchLoadQueries
pCacheSwitchLoadQueries
- new value to setpublic boolean getCacheSwitchLoadQueries()
cacheSwitchLoadQueries
cacheSwitchLoadQueries
public boolean isCacheSwitchLoadQueries()
cacheSwitchLoadQueries
cacheSwitchLoadQueries
public long getLockTimeout()
public void setDefaultUncachedItemQueries(boolean pDefaultUncachedItemQueries)
pDefaultUncachedItemQueries
- new value to setpublic boolean getDefaultUncachedItemQueries()
protected atg.adapter.gsa.ItemCache getItemCache()
protected java.util.Map getNullItems()
public void setUseCacheForDelete(boolean pUseCacheForDelete)
useCacheForDelete
pUseCacheForDelete
- new value to setpublic boolean getUseCacheForDelete()
useCacheForDelete
useCacheForDelete
public boolean isUseCacheForDelete()
useCacheForDelete
useCacheForDelete
public void setWritable(boolean pWritable)
pWritable
- new value to setpublic boolean isWritable()
public void setLoadItemBatchSize(int pLoadItemBatchSize)
loadItemBatchSize
pLoadItemBatchSize
- new value to setpublic int getLoadItemBatchSize()
loadItemBatchSize
loadItemBatchSize
public void setRqlFilterString(java.lang.String pRqlFilterString)
rqlFilterString
. If the RQL string is not
valid for this item descriptor the property is not changed and an error
message is logged if loggingError
is true
.
pRqlFilterString
- new value to setpublic java.lang.String getRqlFilterString()
rqlFilterString
rqlFilterString
public void setRqlFilterParameters(java.lang.Object[] pRqlFilterParameters)
rqlFilterParameters
pRqlFilterParameters
- new value to setpublic java.lang.Object[] getRqlFilterParameters()
rqlFilterParameters
rqlFilterParameters
public void setFilterQuery(atg.adapter.gsa.query.Clause pFilterQuery)
filterQuery
pFilterQuery
- new value to setpublic atg.adapter.gsa.query.Clause getFilterQuery()
filterQuery
filterQuery
public java.lang.Object[] evaluateRqlFilterParams()
public void setCascadeDeleteOrder(int pCascadeDeleteOrder)
cascadeDeleteOrder
pCascadeDeleteOrder
- new value to setpublic int getCascadeDeleteOrder()
cascadeDeleteOrder
This property controls when cascade delete operations are performed. the
legal values are:
Value | String in XML | Meaning | |||||||
---|---|---|---|---|---|---|---|---|---|
CASCADE_DELETE_FIRST |
first | cascade delete is performed before any deletes on the tables of the item | |||||||
CASCADE_DELETE_AFTER_AUX_BEFORE_PRI |
afterAuxiliaryBeforePrimary | cascade delete is performed after auxilary multi table rows but before deleting the primary table row | |||||||
CASCADE_DELETE_LAST |
last | cascade delete is performed after all deletes on the tables of the item |
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |