Package hec.data.meta

Class CatalogTemplate

java.lang.Object

hec.data.meta.CatalogTemplate

All Implemented Interfaces:

MetaCatalogQuery, SqlQuery, Serializable

Direct Known Subclasses:

Catalog

public class CatalogTemplate
extends Object
implements SqlQuery, MetaCatalogQuery

Contains the meta data for a catalog object.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface hec.data.meta.MetaCatalogQuery

META_CATALOG, META_CATALOG_COLUMN_DESCRIPTION, META_CATALOG_COLUMN_NAME, META_CATALOG_COLUMNS, META_CATALOG_OBJECT_DESCRIPTION, META_CATALOG_OBJECT_NAME, META_CATALOG_ORDER_BY, META_CATALOG_ORDER_BY_STRING_ARRAY, META_CATALOG_VISIBLE_COLUMNS

Fields inherited from interface hec.data.meta.SqlQuery

AND, DISTINCT, EQUAL_TO, FROM, GREATER_THAN, GREATER_THAN_EQUAL_TO, LESS_THAN, LESS_THAN_EQUAL_TO, NOT_EQUAL_TO, OR, ORDER_BY, SELECT, UNDEFINED, UPPER, WHERE

Constructor Summary

Constructors

Constructor	Description
CatalogTemplate(CatalogTemplate catTemplate)
CatalogTemplate(String table, String[] columns, boolean[] visible, boolean distinct, Conditional conditional, OrderBy orderBy)
CatalogTemplate(String table, String[] columns, String[] columnNameHeaders, boolean[] visible, boolean distinct, Conditional conditional, OrderBy orderBy)

Method Summary

Modifier and Type	Method	Description
void	addOfficeIdConditional(String officeId, String officeColumn)
String	buildSqlQuery()
StringBuffer	buildSqlQuery(StringBuffer sb)
boolean	containsColumns(String[] columns)
int	getColumnIndex(String columnName)	Returns the column index for a given column name or -1 if the column is not in this catalog.
String[]	getColumnNameHeaders()
String[]	getColumnNames()	Returns the column names for this catalog.
Conditional	getConditional()
boolean	getDistinct()
static CatalogTemplate	getMetaCatalogTemplate()
int	getNumColumns()
OrderBy	getOrderBy()
String	getTable()
boolean[]	getVisibleColumns()
boolean	isDistinct()
boolean	isMetaCatalogTemplate()
void	setConditional(Conditional c)

Methods inherited from class java.lang.Object

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

Constructor Details

CatalogTemplate

public CatalogTemplate(CatalogTemplate catTemplate)

CatalogTemplate

public CatalogTemplate(String table,
 String[] columns,
 boolean[] visible,
 boolean distinct,
 Conditional conditional,
 OrderBy orderBy)
                throws SQLException

Throws:

SQLException

CatalogTemplate

public CatalogTemplate(String table,
 String[] columns,
 String[] columnNameHeaders,
 boolean[] visible,
 boolean distinct,
 Conditional conditional,
 OrderBy orderBy)
                throws SQLException

Throws:

SQLException

Method Details

getMetaCatalogTemplate

public static CatalogTemplate getMetaCatalogTemplate()

getColumnNames

public String[] getColumnNames()

Returns the column names for this catalog.

getColumnNameHeaders

public String[] getColumnNameHeaders()

getColumnIndex

public int getColumnIndex(String columnName)

Returns the column index for a given column name or -1 if the column is not in this catalog.

Parameters:

columnName - a case insensitive String.

Returns:

int index of the column, -1 if the column name is not found.

getOrderBy

public OrderBy getOrderBy()

getVisibleColumns

public boolean[] getVisibleColumns()

getDistinct

public boolean getDistinct()

getConditional

public Conditional getConditional()

setConditional

public void setConditional(Conditional c)

addOfficeIdConditional

public void addOfficeIdConditional(String officeId,
 String officeColumn)

getTable

public String getTable()

isDistinct

public boolean isDistinct()

containsColumns

public boolean containsColumns(String[] columns)

isMetaCatalogTemplate

public boolean isMetaCatalogTemplate()

getNumColumns

public int getNumColumns()

buildSqlQuery

public String buildSqlQuery()

Specified by:

buildSqlQuery in interface SqlQuery

buildSqlQuery

public StringBuffer buildSqlQuery(StringBuffer sb)

Specified by:

buildSqlQuery in interface SqlQuery