com.softwareag.centrasite.appl.framework.fixed
Class FixedRegistryObjectPool

java.lang.Object
  extended by com.softwareag.centrasite.appl.framework.fixed.FixedRegistryObjectPool

public class FixedRegistryObjectPool
extends java.lang.Object

The fixed registry object pool provides a cache for fixed objects. The pool is initialized by one or more XML documents, as specified by the fixedRegistryObjects.xsd schema.


Constructor Summary
FixedRegistryObjectPool()
           
 
Method Summary
 CSAppAssociationType getAssociationType(CSAppAssociationTypeRef pAssocTypeRef)
          Returns an instance of CSAppAssociationType, which has been registered in the pool, and has the given reference objects name.
 CSAppAssociationType getAssociationType(java.lang.String pName)
          Returns an instance of CSAppAssociationType, which has been registered in the pool, and has the given reference objects name.
 CSAppConcept[] getChildConcepts(CSAppConceptRef pParentConceptRef)
          Returns the given parent concepts child concepts, if available, or null.
 CSAppConcept[] getChildConcepts(CSAppTaxonomyRef pAppTaxonomyRef)
          Returns the given taxonomies child concepts, if available, or null.
 CSAppConcept[] getChildConcepts(java.lang.String pPath)
          Returns the given taxonomies, or concepts, child concepts, if available, or null.
 CSAppClassificationScheme getClassificationScheme(CSAppTaxonomyRef pScheme)
          Returns an instance of CSAppClassificationScheme, which has been registered in the pool, and has the given reference objects name.
 CSAppConcept getConcept(CSAppConceptRef pConceptRef)
          Returns an instance of CSAppConcept, which has been registered in the pool, and has the given reference objects path.
 CSAppConcept getConcept(java.lang.String pPath)
          Returns an instance of CSAppConcept, which has been registered in the pool, and has the given path.
 CSAppFixedRegistryObject getFixedRegistryObject(javax.xml.registry.infomodel.Key pKey)
          Returns the fixed registry object with the given key.
 CSAppFixedRegistryObject getFixedRegistryObject(Key pKey)
          Returns the fixed registry object with the given key.
 CSAppFixedRegistryObject getFixedRegistryObject(java.lang.String pKey)
          Returns the fixed registry object with the given Id.
 CSAppObjectType getObjectType(CSAppObjectTypeRef pObjTypeRef)
          Returns an instance of CSAppObjectType, which has been registered in the pool, and has the given reference objects name.
 CSAppObjectType getObjectType(java.lang.String pName)
          Returns an instance of CSAppObjectType, which has been registered in the pool, and has the given reference objects name.
 void load(javax.xml.registry.BusinessQueryManager pQueryManager, FixedRegistryObjectCollection pCollection)
          Loads the given collection of objects into the pool.
 CSAppAssociationType requireAssociationType(CSAppAssociationTypeRef pAssocTypeRef)
          Returns an instance of CSAppAssociationType, which has been registered in the pool, and has the given reference objects name.
 CSAppAssociationType requireAssociationType(java.lang.String pName)
          Returns an instance of CSAppAssociationType, which has been registered in the pool, and has the given reference objects name.
 CSAppConcept[] requireChildConcepts(CSAppConceptRef pParentConceptRef)
          Returns the given parent concepts child concepts.
 CSAppConcept[] requireChildConcepts(CSAppTaxonomyRef pAppTaxonomyRef)
          Returns the given taxonomies child concepts.
 CSAppConcept[] requireChildConcepts(java.lang.String pPath)
          Returns the given taxonomies, or concepts, child concepts.
 CSAppClassificationScheme requireClassificationScheme(CSAppTaxonomyRef pScheme)
          Returns an instance of CSAppClassificationScheme, which has been registered in the pool, and has the given reference objects name.
 CSAppConcept requireConcept(CSAppConceptRef pConceptRef)
          Returns an instance of CSAppConcept, which has been registered in the pool, and has the given reference objects path.
 CSAppConcept requireConcept(java.lang.String pPath)
          Returns an instance of CSAppConcept, which has been registered in the pool, and has the given path.
 CSAppFixedRegistryObject requireFixedRegistryObject(javax.xml.registry.infomodel.Key pKey)
          Returns the fixed registry object with the given key.
 CSAppFixedRegistryObject requireFixedRegistryObject(Key pKey)
          Returns the fixed registry object with the given key.
 CSAppFixedRegistryObject requireFixedRegistryObject(java.lang.String pKey)
          Returns the fixed registry object with the given Id.
 CSAppObjectType requireObjectType(CSAppObjectTypeRef pObjTypeRef)
          Returns an instance of CSAppObjectType, which has been registered in the pool, and has the given reference objects name.
 CSAppObjectType requireObjectType(java.lang.String pName)
          Returns an instance of CSAppObjectType, which has been registered in the pool, and has the given reference objects name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FixedRegistryObjectPool

public FixedRegistryObjectPool()
Method Detail

load

public void load(javax.xml.registry.BusinessQueryManager pQueryManager,
                 FixedRegistryObjectCollection pCollection)
          throws CSAppFrameworkException
Loads the given collection of objects into the pool.

Throws:
CSAppFrameworkException

getClassificationScheme

public CSAppClassificationScheme getClassificationScheme(CSAppTaxonomyRef pScheme)
Returns an instance of CSAppClassificationScheme, which has been registered in the pool, and has the given reference objects name.

Returns:
Requested object, or null, if no such object was available.
See Also:
requireClassificationScheme(CSAppTaxonomyRef)

requireClassificationScheme

public CSAppClassificationScheme requireClassificationScheme(CSAppTaxonomyRef pScheme)
                                                      throws CacheNotAvailableException
Returns an instance of CSAppClassificationScheme, which has been registered in the pool, and has the given reference objects name.

Throws:
CacheNotAvailableException - No such object was found in the pool.
See Also:
getClassificationScheme(CSAppTaxonomyRef)

getAssociationType

public CSAppAssociationType getAssociationType(CSAppAssociationTypeRef pAssocTypeRef)
Returns an instance of CSAppAssociationType, which has been registered in the pool, and has the given reference objects name.

Returns:
Requested object, or null, if no such object was available.
See Also:
requireAssociationType(CSAppAssociationTypeRef)

getAssociationType

public CSAppAssociationType getAssociationType(java.lang.String pName)
Returns an instance of CSAppAssociationType, which has been registered in the pool, and has the given reference objects name.

Returns:
Requested object, or null, if no such object was available.
See Also:
requireAssociationType(String)

requireAssociationType

public CSAppAssociationType requireAssociationType(CSAppAssociationTypeRef pAssocTypeRef)
                                            throws CacheNotAvailableException
Returns an instance of CSAppAssociationType, which has been registered in the pool, and has the given reference objects name.

Throws:
CacheNotAvailableException - No such object was found in the pool.
See Also:
getAssociationType(CSAppAssociationTypeRef)

requireAssociationType

public CSAppAssociationType requireAssociationType(java.lang.String pName)
                                            throws CacheNotAvailableException
Returns an instance of CSAppAssociationType, which has been registered in the pool, and has the given reference objects name.

Throws:
CacheNotAvailableException - No such object was found in the pool.
See Also:
getAssociationType(CSAppAssociationTypeRef)

getObjectType

public CSAppObjectType getObjectType(CSAppObjectTypeRef pObjTypeRef)
Returns an instance of CSAppObjectType, which has been registered in the pool, and has the given reference objects name.

Returns:
Requested object, or null, if no such object was available.
See Also:
requireObjectType(CSAppObjectTypeRef)

getObjectType

public CSAppObjectType getObjectType(java.lang.String pName)
Returns an instance of CSAppObjectType, which has been registered in the pool, and has the given reference objects name.

Returns:
Requested object, or null, if no such object was available.
See Also:
requireObjectType(String)

requireObjectType

public CSAppObjectType requireObjectType(CSAppObjectTypeRef pObjTypeRef)
                                  throws CacheNotAvailableException
Returns an instance of CSAppObjectType, which has been registered in the pool, and has the given reference objects name.

Throws:
CacheNotAvailableException - No such object was found in the pool.
See Also:
getObjectType(CSAppObjectTypeRef)

requireObjectType

public CSAppObjectType requireObjectType(java.lang.String pName)
                                  throws CacheNotAvailableException
Returns an instance of CSAppObjectType, which has been registered in the pool, and has the given reference objects name.

Throws:
CacheNotAvailableException - No such object was found in the pool.
See Also:
getObjectType(String)

getConcept

public CSAppConcept getConcept(CSAppConceptRef pConceptRef)
Returns an instance of CSAppConcept, which has been registered in the pool, and has the given reference objects path.

Returns:
Requested object, or null, if no such object was available.
See Also:
requireConcept(CSAppConceptRef)

getConcept

public CSAppConcept getConcept(java.lang.String pPath)
Returns an instance of CSAppConcept, which has been registered in the pool, and has the given path. The path must include the classification scheme.

Returns:
Requested object, or null, if no such object was available.
See Also:
requireConcept(CSAppConceptRef)

requireConcept

public CSAppConcept requireConcept(CSAppConceptRef pConceptRef)
                            throws CacheNotAvailableException
Returns an instance of CSAppConcept, which has been registered in the pool, and has the given reference objects path.

Throws:
CacheNotAvailableException - No such object was found in the pool.
See Also:
getConcept(CSAppConceptRef)

requireConcept

public CSAppConcept requireConcept(java.lang.String pPath)
                            throws CacheNotAvailableException
Returns an instance of CSAppConcept, which has been registered in the pool, and has the given path. The path must include the classification scheme.

Throws:
CacheNotAvailableException - No such object was found in the pool.
See Also:
getConcept(CSAppConceptRef)

getChildConcepts

public CSAppConcept[] getChildConcepts(java.lang.String pPath)
Returns the given taxonomies, or concepts, child concepts, if available, or null.

Parameters:
pPath - The taxonomies, or parent concepts path. In the case of a parent concept, this is the fully qualified path, including a leading "/" and the taxonomies name.
Returns:
Array of child concepts, if available, or null.

requireChildConcepts

public CSAppConcept[] requireChildConcepts(java.lang.String pPath)
                                    throws CacheNotAvailableException
Returns the given taxonomies, or concepts, child concepts.

Parameters:
pPath - The taxonomies, or parent concepts path. In the case of a parent concept, this is the fully qualified path, including a leading "/" and the taxonomies name.
Returns:
Array of child concepts, never null
Throws:
CacheNotAvailableException - The given taxonomies, or parent concepts, list of child concepts is not available, because the taxonomy doesn't have a cache strategy "childs".

getChildConcepts

public CSAppConcept[] getChildConcepts(CSAppTaxonomyRef pAppTaxonomyRef)
Returns the given taxonomies child concepts, if available, or null.


requireChildConcepts

public CSAppConcept[] requireChildConcepts(CSAppTaxonomyRef pAppTaxonomyRef)
                                    throws CacheNotAvailableException
Returns the given taxonomies child concepts.

Throws:
CacheNotAvailableException - The given taxonomies child concept list is not available, because the taxonomy doesn't have a cache strategy "childs".

getChildConcepts

public CSAppConcept[] getChildConcepts(CSAppConceptRef pParentConceptRef)
Returns the given parent concepts child concepts, if available, or null.


requireChildConcepts

public CSAppConcept[] requireChildConcepts(CSAppConceptRef pParentConceptRef)
                                    throws CacheNotAvailableException
Returns the given parent concepts child concepts.

Throws:
CacheNotAvailableException - The given parent concepts child concept list is not available, because the concept doesn't have a cache strategy "childs".

getFixedRegistryObject

public CSAppFixedRegistryObject getFixedRegistryObject(javax.xml.registry.infomodel.Key pKey)
                                                throws CSAppFrameworkException
Returns the fixed registry object with the given key. The object must be predefined in the pool.

Returns:
Fixed registry object with the given key, if known, or null.
Throws:
CSAppFrameworkException

requireFixedRegistryObject

public CSAppFixedRegistryObject requireFixedRegistryObject(javax.xml.registry.infomodel.Key pKey)
                                                    throws CSAppFrameworkException,
                                                           CacheNotAvailableException
Returns the fixed registry object with the given key. The object must be predefined in the pool.

Returns:
Fixed registry object with the given key, never null.
Throws:
CacheNotAvailableException - No such object was predefined in the pool.
CSAppFrameworkException

getFixedRegistryObject

public CSAppFixedRegistryObject getFixedRegistryObject(Key pKey)
                                                throws CSAppFrameworkException
Returns the fixed registry object with the given key. The object must be predefined in the pool.

Returns:
Fixed registry object with the given key, if known, or null.
Throws:
CSAppFrameworkException

requireFixedRegistryObject

public CSAppFixedRegistryObject requireFixedRegistryObject(Key pKey)
                                                    throws CSAppFrameworkException,
                                                           CacheNotAvailableException
Returns the fixed registry object with the given key. The object must be predefined in the pool.

Returns:
Fixed registry object with the given key, never null.
Throws:
CacheNotAvailableException - No such object was predefined in the pool.
CSAppFrameworkException

getFixedRegistryObject

public CSAppFixedRegistryObject getFixedRegistryObject(java.lang.String pKey)
                                                throws CSAppFrameworkException
Returns the fixed registry object with the given Id. The object must be predefined in the pool.

Returns:
Fixed registry object with the given key, if known, or null.
Throws:
CSAppFrameworkException

requireFixedRegistryObject

public CSAppFixedRegistryObject requireFixedRegistryObject(java.lang.String pKey)
                                                    throws CSAppFrameworkException,
                                                           CacheNotAvailableException
Returns the fixed registry object with the given Id. The object must be predefined in the pool.

Returns:
Fixed registry object with the given key, never null.
Throws:
CacheNotAvailableException - No such object was predefined in the pool.
CSAppFrameworkException