com.facetmap.sql
Class SqlFacetmap

java.lang.Object
  com.facetmap.simple.SimpleFacetmap
      com.facetmap.sql.SqlFacetmap

All Implemented Interfaces:

Facetmap

public class SqlFacetmap
extends SimpleFacetmap

A Facetmap implementation using a SQL relational database as a persistence layer, and a schema that enables very fast Selection queries in multiple facets.

Supported properties are:

• com.facetmap.sql.jdbcDriver - fully-qualified name of the driver class
• com.facetmap.sql.jdbcUrl - JDBC-protocol URL of the database to use, for example jdbc:mysql://localhost:3306/databaseName?user=facetmap
• com.facetmap.sql.sqlVendor - the vendor flavor of SQL for your database. Supported values are mysql; please let us know if you have a need for another.
• com.facetmap.sql.tablePrefix - if set, all tables Facetmap creates in your database will be prefixed with this value, to avoid namespace conflicts or just for recognition.

Field Summary

protected ConnectionManager	connectionManager
protected SqlFacetSpace	sqlFacetSpace
protected SqlResourceFactory	sqlResourceFactory
protected java.lang.String	sqlVendor
protected java.lang.String	tableName
protected java.lang.String	tablePrefix
protected java.lang.String	tagTableName

Fields inherited from class com.facetmap.simple.SimpleFacetmap

facetSpace, INFO, refCodec, resourceSpace, selectionProps, title

Constructor Summary

SqlFacetmap(Facetmap sourceData, java.util.Properties properties)
Creates a SqlFacetmap from source data in another Facetmap object.

SqlFacetmap(Facetmap sourceData, java.util.Properties properties, ConnectionManager connectionManager)
Creates a SqlFacetmap that uses a specified Connection management mechanism.

SqlFacetmap(Facetmap sourceData, java.util.Properties properties, ConnectionManager connectionManager, java.util.Collection externalFacets)
Constructor for fully-customizable Facetmap, including custom ConnectionManager and external ResourceIdFacet objects.

Method Summary

FacetSpace	getFacetSpace()
java.lang.String	getInfo() Implementation-specific string for this FacetMap class.
RefCodec	getRefCodec()
ResourceIdFacet	getResourceIdFacet(java.lang.String id) Returns a ResourceIdFacet for integrating external queries.
Selection	getRootSelection(java.util.Properties props) Caches root selection for the life of the SimpleFacetmap object, which underscores the intended immutability of SimpleFacetmap.
Selection	getSelection(Heading[] headingList, java.util.Properties props) This is the basic getSelection call.
Selection	getSelection(java.lang.String ref, java.util.Properties properties) Get a Selection defined by string ref and subject to special restrictions in properties.
SqlSelection	getSqlSelection(java.sql.Connection connection, Heading[] headingList, java.util.Properties properties) This getSelection allows you to pass in your own live Connection object, for the times when you want Facetmap to use the same Connection that you are using elsewhere in your code.
SqlSelection	getSqlSelection(Heading[] headingList, java.util.Properties properties)
void	notifyAddedResource(int resourceId) Notify this object that a new Resource has been added to its ResourceSpace, and should be incrementally added to the internal representation of the facetmap.
void	notifyResourceToBeDeleted(int resourceId) Notify this object that a Resource is about to be deleted from its ResourceSpace, and should be removed from the internal representation of the facetmap.

Methods inherited from class com.facetmap.simple.SimpleFacetmap

applyHeadingsToSelection, applyHeadingsToSelection, applyPropertiesToSelection, booleanProperty, defineBackwardSelections, defineForwardSelections, getCommonAncestor, getResourceSpace, getRootSelection, getSelection, getSelection, getSelectionProps, getTitle, headingIsAncestorOfHeading, intProperty, isSelectedInFacet, removeEmptySelections, setResourceSpace, setSelectionProps, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

sqlVendor

protected java.lang.String sqlVendor

connectionManager

protected ConnectionManager connectionManager

tablePrefix

protected java.lang.String tablePrefix

tableName

protected java.lang.String tableName

tagTableName

protected java.lang.String tagTableName

sqlFacetSpace

protected SqlFacetSpace sqlFacetSpace

sqlResourceFactory

protected SqlResourceFactory sqlResourceFactory

Constructor Detail

SqlFacetmap

public SqlFacetmap(Facetmap sourceData,
                   java.util.Properties properties)
            throws DataException,
                   InternalException

Creates a SqlFacetmap from source data in another Facetmap object. Database connections will be pooled, and created based on the com.facetmap.sql properties passed into this method.

Throws:

DataException

InternalException

SqlFacetmap

public SqlFacetmap(Facetmap sourceData,
                   java.util.Properties properties,
                   ConnectionManager connectionManager)
            throws DataException,
                   InternalException

Creates a SqlFacetmap that uses a specified Connection management mechanism.

Parameters:

connectionManager - - the object responsible for providing Connections to SqlFacetmap. (e.g. a connection pool, DataSource, etc)

Throws:

DataException

InternalException

See Also:

ConnectionManager

SqlFacetmap

public SqlFacetmap(Facetmap sourceData,
                   java.util.Properties properties,
                   ConnectionManager connectionManager,
                   java.util.Collection externalFacets)
            throws DataException,
                   InternalException

Constructor for fully-customizable Facetmap, including custom ConnectionManager and external ResourceIdFacet objects. ResourceIdFacet is the only type supported in the externalFacets Collection argument.

Throws:

DataException

InternalException

Method Detail

getInfo

public java.lang.String getInfo()

Description copied from class: SimpleFacetmap

Implementation-specific string for this FacetMap class.

Specified by:

getInfo in interface Facetmap

Overrides:

getInfo in class SimpleFacetmap

getResourceIdFacet

public ResourceIdFacet getResourceIdFacet(java.lang.String id)

Returns a ResourceIdFacet for integrating external queries. See ResourceIdFacet for docs explaining how to do this.

This method is on the Facetmap instead of the FacetSpace, since a ResourceIdFacet is not really part of the FacetSpace to which Resources have been mapped. It is considered an "external facet".

getRootSelection

public Selection getRootSelection(java.util.Properties props)
                           throws InternalException

Description copied from class: SimpleFacetmap

Caches root selection for the life of the SimpleFacetmap object, which underscores the intended immutability of SimpleFacetmap.

Specified by:

getRootSelection in interface Facetmap

Overrides:

getRootSelection in class SimpleFacetmap

Throws:

InternalException

See Also:

Facetmap.getSelection(Heading[], Properties)

getSelection

public Selection getSelection(Heading[] headingList,
                              java.util.Properties props)
                       throws DataException,
                              InternalException

Description copied from class: SimpleFacetmap

This is the basic getSelection call. Other getSelection methods in this class eventually call this one, so this is the one you need to rewrite if you're writing your own getSelection code.

Specified by:

getSelection in interface Facetmap

Overrides:

getSelection in class SimpleFacetmap

Throws:

DataException

InternalException

See Also:

Facetmap.getSelection(Heading[])

getSelection

public Selection getSelection(java.lang.String ref,
                              java.util.Properties properties)
                       throws InternalException,
                              UnknownReferenceException

Description copied from interface: Facetmap

Get a Selection defined by string ref and subject to special restrictions in properties. Note that selection properties are not conveyed by the ref string.

Specified by:

getSelection in interface Facetmap

Overrides:

getSelection in class SimpleFacetmap

Throws:

InternalException

UnknownReferenceException

getSqlSelection

public SqlSelection getSqlSelection(Heading[] headingList,
                                    java.util.Properties properties)
                             throws InternalException

Throws:

InternalException

getSqlSelection

public SqlSelection getSqlSelection(java.sql.Connection connection,
                                    Heading[] headingList,
                                    java.util.Properties properties)

This getSelection allows you to pass in your own live Connection object, for the times when you want Facetmap to use the same Connection that you are using elsewhere in your code. In this case the ConnectionManager won't be used. This is also the function that all SqlFacetmap.getSelection methods internally call.

getRefCodec

public RefCodec getRefCodec()

getFacetSpace

public FacetSpace getFacetSpace()

Specified by:

getFacetSpace in interface Facetmap

Overrides:

getFacetSpace in class SimpleFacetmap

notifyAddedResource

public void notifyAddedResource(int resourceId)
                         throws InternalException

Notify this object that a new Resource has been added to its ResourceSpace, and should be incrementally added to the internal representation of the facetmap.

NOTE: this method will be deprecated in the future. It exposes an event-driven model which is not fully supported by this package, which is why you need to call it explicitly. When the ResourceSpace supports events, this method is likely to be inaccessible.

Parameters:

resourceId - - the ID of the newly added Resource

Throws:

InternalException

notifyResourceToBeDeleted

public void notifyResourceToBeDeleted(int resourceId)
                               throws InternalException

Notify this object that a Resource is about to be deleted from its ResourceSpace, and should be removed from the internal representation of the facetmap. Whereas notifyAddedResource is called after the Resource is added to the ResourceSpace, this method should be called before the Resource is deleted from the ResourceSpace (so that the resource is still available to this method).

NOTE: this method will be deprecated in the future. It exposes an event-driven model which is not fully supported by this package, which is why you need to call it explicitly. When the ResourceSpace supports events, this method is likely to be inaccessible.

Parameters:

resourceId - - the ID of the Resource about to be deleted

Throws:

InternalException