org.xbup.catalog

Class XBECatalog

java.lang.Object

org.xbup.catalog.XBECatalog

All Implemented Interfaces:

XBCatalog

Direct Known Subclasses:

XBAECatalog

public class XBECatalog
extends java.lang.Object
implements XBCatalog

Basic level 1 catalog class using Java Persistence.

Version:

0.1 wr21.0 2012/04/01

Author:

XBUP Project (http://xbup.org)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Class,XBCManager<?>>	catalogManagers
protected java.util.Map<java.lang.Class,XBCService<?>>	catalogServices
protected javax.persistence.EntityManager	em
protected java.util.Map<java.lang.Class,XBCManager<?>>	extensionManagers
protected java.util.Map<java.lang.Class,XBCService<?>>	extensionServices

Constructor Summary

Constructors

Constructor and Description
XBECatalog(javax.persistence.EntityManager em, java.lang.String fileRepositoryPath) Creates a new instance of XBECatalog

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.
XBEBlockSpec	findBlockSpecByPath(java.lang.Long[] xbCatalogPath)
XBBlockDecl	findBlockTypeByPath(java.lang.Long[] xbCatalogPath) Returns a type of block for given XB Path.
XBEFormatSpec	findFormatSpecByPath(java.lang.Long[] xbCatalogPath)
XBFormatDecl	findFormatTypeByPath(java.lang.Long[] xbCatalogPath) Returns a format type for given XB Path.
XBEGroupSpec	findGroupSpecByPath(java.lang.Long[] xbCatalogPath)
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.
javax.persistence.EntityManager	getEntityManager()
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.lang.String	getFileRepositoryPath()
java.util.List<XBGroupDecl>	getGroups(XBCFormatSpec spec) Returns list of binded specifications for given format specification for processing context.
XBContext	getRootContext() Returns a processing context for empty document.
XBCUpdateHandler	getUpdateHandler()
void	initCatalog()
void	initContext()
boolean	isShallInit()
void	setFileRepositoryPath(java.lang.String fileRepositoryPath)
void	setUpdateHandler(XBCUpdateHandler updateHandler)

Methods inherited from class java.lang.Object

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

Field Detail

em

protected javax.persistence.EntityManager em

catalogManagers

protected java.util.Map<java.lang.Class,XBCManager<?>> catalogManagers

catalogServices

protected java.util.Map<java.lang.Class,XBCService<?>> catalogServices

extensionManagers

protected java.util.Map<java.lang.Class,XBCManager<?>> extensionManagers

extensionServices

protected java.util.Map<java.lang.Class,XBCService<?>> extensionServices

Constructor Detail

XBECatalog

public XBECatalog(javax.persistence.EntityManager em,
          java.lang.String fileRepositoryPath)

Creates a new instance of XBECatalog

Method Detail

findFormatSpecByPath

public XBEFormatSpec findFormatSpecByPath(java.lang.Long[] xbCatalogPath)

findGroupSpecByPath

public XBEGroupSpec findGroupSpecByPath(java.lang.Long[] xbCatalogPath)

findBlockSpecByPath

public XBEBlockSpec findBlockSpecByPath(java.lang.Long[] xbCatalogPath)

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.

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.

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.

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.

initCatalog

public void initCatalog()

initContext

public void initContext()

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.

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

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

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

getEntityManager

public javax.persistence.EntityManager getEntityManager()

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.

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.

getUpdateHandler

public XBCUpdateHandler getUpdateHandler()

setUpdateHandler

public void setUpdateHandler(XBCUpdateHandler updateHandler)

isShallInit

public boolean isShallInit()

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.

getFileRepositoryPath

public java.lang.String getFileRepositoryPath()

Returns:

the fileRepositoryPath

setFileRepositoryPath

public void setFileRepositoryPath(java.lang.String fileRepositoryPath)

Parameters:

fileRepositoryPath - the fileRepositoryPath to set