XBCatalog (XBUP Library)

All Known Subinterfaces:

XBACatalog

All Known Implementing Classes:

XBAECatalog, XBARCatalog, XBCachedCatalog, XBECatalog, XBRCatalog
```
public interface XBCatalog
```
Interface for XBUP level 1 catalog.

Version:

0.1 wr21.0 2012/01/01

Author:

XBUP Project (http://xbup.org)

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.
`XBContext`	`getRootContext()` Returns a processing context for empty document.

- Method Detail
  - findBlockTypeByPath
```
XBBlockDecl findBlockTypeByPath(java.lang.Long[] xbCatalogPath)
```
    Returns a type of block for given XB Path.
    
    Parameters:
    xbCatalogPath - a path in catalog using xbIndexes.
    
    Returns:
    the block type declaration for given catalog or null if traversal fails.
  - findGroupTypeByPath
```
XBGroupDecl findGroupTypeByPath(java.lang.Long[] xbCatalogPath)
```
    Returns a group type for given XB Path.
    
    Parameters:
    xbCatalogPath - a path in catalog using xbIndexes.
    
    Returns:
    Group Type for given catalog or null if fails.
  - findFormatTypeByPath
```
XBFormatDecl findFormatTypeByPath(java.lang.Long[] xbCatalogPath)
```
    Returns a format type for given XB Path.
    
    Parameters:
    xbCatalogPath - a path in catalog using xbIndexes.
    
    Returns:
    Format Type for given catalog or null if fails.
  - getRootContext
```
XBContext getRootContext()
```
    Returns a processing context for empty document.
    
    Returns:
    block types processing context.
  - getGroups
```
java.util.List<XBGroupDecl> getGroups(XBCFormatSpec spec)
```
    Returns list of binded specifications for given format specification for processing context.
    
    Parameters:
    spec - a format specification.
    
    Returns:
    list of group specifications.
  - getBlocks
```
java.util.List<XBBlockDecl> getBlocks(XBCGroupSpec spec)
```
    Returns list of binded specifications for given group specification for processing context.
    
    Parameters:
    spec - a group specification.
    
    Returns:
    list of block specifications.
  - getCatalogService
```
XBCService<? extends XBCBase> getCatalogService(java.lang.Class type)
```
    Returns catalog service of given type.
    
    Parameters:
    type - a class for desired instance of catalog service.
    
    Returns:
    service.
  - getCatalogManager
```
XBCManager<? extends XBCBase> getCatalogManager(java.lang.Class type)
```
    Returns catalog manager of given type.
    
    Parameters:
    type - a class for desired instance of catalog manager.
    
    Returns:
    manager.
  - getExtensionService
```
XBCService<? extends XBCBase> getExtensionService(java.lang.Class type)
```
    Returns catalog extension service of given catalog's type.
    
    Parameters:
    type - a class for desired instance of catalog manager.
    
    Returns:
    the instance of ItemManager.
  - getExtensionServices
```
java.util.List<XBCService<? extends XBCBase>> getExtensionServices()
```
    Returns list of catalog extensions.
    
    Returns:
    list of all catalog extensions.
  - getExtensionManager
```
XBCManager<? extends XBCBase> getExtensionManager(java.lang.Class type)
```
    Returns catalog extension service of given catalog's type.
    
    Parameters:
    type - a class for desired instance of catalog manager.
    
    Returns:
    the instance of ItemManager.
  - getExtensionManagers
```
java.util.List<XBCManager<? extends XBCBase>> getExtensionManagers()
```
    Returns list of catalog extensions.
    
    Returns:
    list of all catalog extensions.
  - addCatalogManager
```
void addCatalogManager(java.lang.Class type,
                     XBCManager<? extends XBCBase> ext)
```
    Add catalog manager to catalog repository. Should be used only for internal purposes.
    
    Parameters:
    type - type of extension
    ext - instance of extension, must implement XBCExtension
  - addExtensionManager
```
void addExtensionManager(java.lang.Class type,
                       XBCManager<? extends XBCBase> ext)
```
    Add extension manager to catalog repository.
    
    Parameters:
    type - type of extension
    ext - instance of extension, must implement XBCExtension
  - addExtensionService
```
void addExtensionService(java.lang.Class type,
                       XBCService<? extends XBCBase> ext)
```
    Add extension service to catalog repository.
    
    Parameters:
    type - type of extension
    ext - instance of extension, must implement XBCExtension

Interface XBCatalog

Method Summary

Method Detail

findBlockTypeByPath

findGroupTypeByPath

findFormatTypeByPath

getRootContext

getGroups

getBlocks

getCatalogService

getCatalogManager

getExtensionService

getExtensionServices

getExtensionManager

getExtensionManagers

addCatalogManager

addExtensionManager

addExtensionService