Package org.daisy.dotify.api.table

Class TableCatalog

java.lang.Object

org.daisy.dotify.api.table.TableCatalog

All Implemented Interfaces:

FactoryCatalog<Table>, TableCatalogService

public class TableCatalog
extends Object
implements FactoryCatalog<Table>, TableCatalogService

Provides a catalog of Table factories.

Constructor Summary

Constructors

Constructor	Description
TableCatalog()	Creates a new empty instance.

Method Summary

Modifier and Type	Method	Description
void	addFactory(TableProvider factory)	Adds a factory (intended for use by the OSGi framework)
Table	get(String identifier)	Gets the Factory with this identifier
Collection<FactoryProperties>	list()	Lists the tables
Collection<FactoryProperties>	list(TableFilter filter)	Lists the tables that matches the specified filter
static TableCatalog	newInstance()	Creates a new TableCatalog and populates it using the SPI (java service provider interface).
Table	newTable(String identifier)	Creates a new table with the specified identifier.
void	removeFactory(TableProvider factory)	Removes a factory (intended for use by the OSGi framework)

Methods inherited from class java.lang.Object

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

Constructor Detail

TableCatalog

public TableCatalog()

Creates a new empty instance. This method is public because it is required by OSGi. In an SPI context, use newInstance()

Method Detail

newInstance

public static TableCatalog newInstance()

Creates a new TableCatalog and populates it using the SPI (java service provider interface).

In an OSGi context, an instance should be retrieved using the service registry. It will be registered under the TableCatalogService interface.

Returns:

returns a new TableCatalog

addFactory

public void addFactory(TableProvider factory)

Adds a factory (intended for use by the OSGi framework)

Parameters:

factory - the factory to add

removeFactory

public void removeFactory(TableProvider factory)

Removes a factory (intended for use by the OSGi framework)

Parameters:

factory - the factory to remove

get

public Table get(String identifier)

Description copied from interface: FactoryCatalog

Gets the Factory with this identifier

Specified by:

get in interface FactoryCatalog<Table>

Parameters:

identifier - the identifier for the requested Factory

Returns:

returns the Factory with this identifier, or null if none is found

newTable

public Table newTable(String identifier)

Description copied from interface: TableCatalogService

Creates a new table with the specified identifier.

Specified by:

newTable in interface TableCatalogService

Parameters:

identifier - the identifier

Returns:

returns a new table

list

public Collection<FactoryProperties> list()

Description copied from interface: TableCatalogService

Lists the tables

Specified by:

list in interface TableCatalogService

Returns:

returns a collection of table properties

list

public Collection<FactoryProperties> list(TableFilter filter)

Description copied from interface: TableCatalogService

Lists the tables that matches the specified filter

Specified by:

list in interface TableCatalogService

Parameters:

filter - the filter

Returns:

returns a collection fo table properties