org.xbup.catalog

Class XBCachedCatalog

java.lang.Object

org.xbup.catalog.XBCachedCatalog

All Implemented Interfaces:

XBCatalog

public class XBCachedCatalog
extends java.lang.Object
implements XBCatalog

TODO: Basic class supporting local catalog handling for application via interface to XBService with local caching.

Version:

0.1 wr15.0 2007/05/04

Author:

XBUP Project (http://xbup.org)

Constructor Summary

Constructors

Constructor and Description
XBCachedCatalog() Creates a new instance of XBCachedCatalog

Method Summary

Methods

Modifier and Type	Method and Description
void	addCatalogManager(java.lang.Class type, XBCManager<? extends XBCBase> ext) Add catalog manager to catalog repository.
void	addExtensionManager(java.lang.Class type, XBCManager<? extends XBCBase> ext) Add extension manager to catalog repository.
void	addExtensionService(java.lang.Class type, XBCService<? extends XBCBase> ext) Add extension service to catalog repository.
XBBlockDecl	findBlockTypeByPath(java.lang.Long[] xbCatalogPath) Returns a type of block for given XB Path.
XBFormatDecl	findFormatTypeByPath(java.lang.Long[] xbCatalogPath) Returns a format type for given XB Path.
XBGroupDecl	findGroupTypeByPath(java.lang.Long[] xbCatalogPath) Returns a group type for given XB Path.
java.util.List<XBBlockDecl>	getBlocks(XBCGroupSpec spec) Returns list of binded specifications for given group specification for processing context.
XBCManager<? extends XBCBase>	getCatalogManager(java.lang.Class type) Returns catalog manager of given type.
XBCService<? extends XBCBase>	getCatalogService(java.lang.Class type) Returns catalog service of given type.
XBCManager<? extends XBCBase>	getExtensionManager(java.lang.Class type) Returns catalog extension service of given catalog's type.
java.util.List<XBCManager<? extends XBCBase>>	getExtensionManagers() Returns list of catalog extensions.
XBCService<? extends XBCBase>	getExtensionService(java.lang.Class type) Returns catalog extension service of given catalog's type.
java.util.List<XBCService<? extends XBCBase>>	getExtensionServices() Returns list of catalog extensions.
java.util.List<XBGroupDecl>	getGroups(XBCFormatSpec spec) Returns list of binded specifications for given format specification for processing context.
XBCItem	getItem(long itemId)
XBContext	getRootContext() Returns a processing context for empty document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XBCachedCatalog

public XBCachedCatalog()

Creates a new instance of XBCachedCatalog

Method Detail

getRootContext

public XBContext getRootContext()

Description copied from interface: XBCatalog

Returns a processing context for empty document.

Specified by:

getRootContext in interface XBCatalog

Returns:

block types processing context.

getItem

public XBCItem getItem(long itemId)

findBlockTypeByPath

public XBBlockDecl findBlockTypeByPath(java.lang.Long[] xbCatalogPath)

Description copied from interface: XBCatalog

Returns a type of block for given XB Path.

Specified by:

findBlockTypeByPath in interface XBCatalog

Parameters:

xbCatalogPath - a path in catalog using xbIndexes.

Returns:

the block type declaration for given catalog or null if traversal fails.

findGroupTypeByPath

public XBGroupDecl findGroupTypeByPath(java.lang.Long[] xbCatalogPath)

Description copied from interface: XBCatalog

Returns a group type for given XB Path.

Specified by:

findGroupTypeByPath in interface XBCatalog

Parameters:

xbCatalogPath - a path in catalog using xbIndexes.

Returns:

Group Type for given catalog or null if fails.

findFormatTypeByPath

public XBFormatDecl findFormatTypeByPath(java.lang.Long[] xbCatalogPath)

Description copied from interface: XBCatalog

Returns a format type for given XB Path.

Specified by:

findFormatTypeByPath in interface XBCatalog

Parameters:

xbCatalogPath - a path in catalog using xbIndexes.

Returns:

Format Type for given catalog or null if fails.

getGroups

public java.util.List<XBGroupDecl> getGroups(XBCFormatSpec spec)

Description copied from interface: XBCatalog

Returns list of binded specifications for given format specification for processing context.

Specified by:

getGroups in interface XBCatalog

Parameters:

spec - a format specification.

Returns:

list of group specifications.

getBlocks

public java.util.List<XBBlockDecl> getBlocks(XBCGroupSpec spec)

Description copied from interface: XBCatalog

Returns list of binded specifications for given group specification for processing context.

Specified by:

getBlocks in interface XBCatalog

Parameters:

spec - a group specification.

Returns:

list of block specifications.

getCatalogManager

public XBCManager<? extends XBCBase> getCatalogManager(java.lang.Class type)

Description copied from interface: XBCatalog

Returns catalog manager of given type.

Specified by:

getCatalogManager in interface XBCatalog

Parameters:

type - a class for desired instance of catalog manager.

Returns:

manager.

getCatalogService

public XBCService<? extends XBCBase> getCatalogService(java.lang.Class type)

Description copied from interface: XBCatalog

Returns catalog service of given type.

Specified by:

getCatalogService in interface XBCatalog

Parameters:

type - a class for desired instance of catalog service.

Returns:

service.

getExtensionService

public XBCService<? extends XBCBase> getExtensionService(java.lang.Class type)

Description copied from interface: XBCatalog

Returns catalog extension service of given catalog's type.

Specified by:

getExtensionService in interface XBCatalog

Parameters:

type - a class for desired instance of catalog manager.

Returns:

the instance of ItemManager.

getExtensionServices

public java.util.List<XBCService<? extends XBCBase>> getExtensionServices()

Description copied from interface: XBCatalog

Returns list of catalog extensions.

Specified by:

getExtensionServices in interface XBCatalog

Returns:

list of all catalog extensions.

addExtensionManager

public void addExtensionManager(java.lang.Class type,
                       XBCManager<? extends XBCBase> ext)

Description copied from interface: XBCatalog

Add extension manager to catalog repository.

Specified by:

addExtensionManager in interface XBCatalog

Parameters:

type - type of extension

ext - instance of extension, must implement XBCExtension

addExtensionService

public void addExtensionService(java.lang.Class type,
                       XBCService<? extends XBCBase> ext)

Description copied from interface: XBCatalog

Add extension service to catalog repository.

Specified by:

addExtensionService in interface XBCatalog

Parameters:

type - type of extension

ext - instance of extension, must implement XBCExtension

getExtensionManager

public XBCManager<? extends XBCBase> getExtensionManager(java.lang.Class type)

Description copied from interface: XBCatalog

Returns catalog extension service of given catalog's type.

Specified by:

getExtensionManager in interface XBCatalog

Parameters:

type - a class for desired instance of catalog manager.

Returns:

the instance of ItemManager.

getExtensionManagers

public java.util.List<XBCManager<? extends XBCBase>> getExtensionManagers()

Description copied from interface: XBCatalog

Returns list of catalog extensions.

Specified by:

getExtensionManagers in interface XBCatalog

Returns:

list of all catalog extensions.

addCatalogManager

public void addCatalogManager(java.lang.Class type,
                     XBCManager<? extends XBCBase> ext)

Description copied from interface: XBCatalog

Add catalog manager to catalog repository. Should be used only for internal purposes.

Specified by:

addCatalogManager in interface XBCatalog

Parameters:

type - type of extension

ext - instance of extension, must implement XBCExtension