com.facetmap.sql
Interface SqlHeading

All Known Implementing Classes:
CompoundIndexedHeading, DateHeadingImpl, IndexedHeading, ResourceIdHeading, SpectrumHeadingImpl

public interface SqlHeading

Provides methods used by the SQL compilation of resource heading data.


Method Summary
 java.lang.String sqlFilterClause(java.util.Properties properties)
          Return a WHERE clause (without the "WHERE" or "AND" string) that selects resources in this heading.
 void sqlMap(java.sql.Connection connection, SqlResource resource)
          Create the SQL representation of the mapping between a Resource and this Heading.
 void sqlUnmap(java.sql.Connection connection, SqlResource resource)
           
 

Method Detail

sqlFilterClause

java.lang.String sqlFilterClause(java.util.Properties properties)
Return a WHERE clause (without the "WHERE" or "AND" string) that selects resources in this heading. vendor argument specifies the vendor dialect of SQL to return, and can be ignored for vanilla SQL.

Method may also return null, to indicate no filtering should be done (i.e. this heading selects all resources).

Default is to filter nothing (i.e. select everything).


sqlMap

void sqlMap(java.sql.Connection connection,
            SqlResource resource)
            throws java.sql.SQLException
Create the SQL representation of the mapping between a Resource and this Heading. REVISIT argument list.

Throws:
java.sql.SQLException

sqlUnmap

void sqlUnmap(java.sql.Connection connection,
              SqlResource resource)
              throws java.sql.SQLException
Throws:
java.sql.SQLException