Class Table
Object
AbstractTable
Table
Table
- All Implemented Interfaces:
Serializable
,Comparable<Table>
,DatamartContext.Table
,NamedStructure
,Table
,HasName
Represents a table and its metadata description.
- See Also:
-
Field Summary
Fields inherited from class Table
columns, name, remarks, schema, type
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDMFieldCollection
fc()
getColumn
(int index) Convenience method for retrieving a column by its name.getColumnByLabel
(String columnLabel) Convenience method for retrieving a column by its label.DMFieldCollection
The underlying FC's source name.boolean
isView()
void
setIsView
(boolean view) void
setUseRefreshData
(Boolean useRefreshData) Methods inherited from class Table
getColumns, getName, getQuote, getRelationships, getRemarks, getSchema, getType
Methods inherited from class AbstractTable
compareTo, equals, getBooleanColumns, getColumnByName, getColumnCount, getColumnNames, getColumnsOfSuperType, getColumnsOfType, getForeignKeyRelationships, getForeignKeys, getIndexedColumns, getLiteralColumns, getNumberColumns, getPrimaryKeyRelationships, getPrimaryKeys, getQualifiedLabel, getQuotedName, getRelationshipCount, getRelationships, getTimeBasedColumns, hashCode, toString
-
Field Details
-
fc
protected transient DMFieldCollection fc
-
-
Constructor Details
-
Table
protected Table(DMFieldCollection fc, Schema schema)
-
-
Method Details
-
isView
public boolean isView() -
setIsView
public void setIsView(boolean view) -
getUseRefreshData
-
setUseRefreshData
-
getColumn
Description copied from interface:DatamartContext.Table
Convenience method for retrieving a column by its name.Example:
def ctx = api.getDatamartContext() def dm = ctx.getDatamart("Transactions_DM") def ccDim = dm.getColumn("CC") def cc = ctx.dimFilterEntry("CC", ccDim) if (cc!=null) return cc.value
- Specified by:
getColumn
in interfaceDatamartContext.Table
- Overrides:
getColumn
in classTable
- Parameters:
columnName
- the name of the column to retrieve- Returns:
- the column with the given name. Returns null if no such column is found.
-
getColumn
- Specified by:
getColumn
in interfaceDatamartContext.Table
- Specified by:
getColumn
in interfaceTable
- Overrides:
getColumn
in classAbstractTable
-
getColumnByLabel
Description copied from interface:DatamartContext.Table
Convenience method for retrieving a column by its label.- Specified by:
getColumnByLabel
in interfaceDatamartContext.Table
- Parameters:
columnLabel
- the label of the column to retrieve- Returns:
- the column with the given label. Returns null if no such column is found.
-
fc
public DMFieldCollection fc() -
getFieldCollection
public DMFieldCollection getFieldCollection() -
getSourceName
Description copied from interface:DatamartContext.Table
The underlying FC's source name.It can be useful when the source name is required by other APIs.
- Specified by:
getSourceName
in interfaceDatamartContext.Table
- Returns:
- The source name
-