Package net.pricefx.server.util.metamodel.dm

Class Table

Object
AbstractTable
Table
Table
All Implemented Interfaces:
Serializable, Comparable<Table>, DatamartContext.Table, NamedStructure, Table, HasName
public class Table extends Table implements DatamartContext.Table
Represents a table and its metadata description.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected DMFieldCollection
    fc
     

    Fields inherited from class Table

    columns, name, remarks, schema, type

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Table(DMFieldCollection fc, Schema schema)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    DMFieldCollection
    fc()
     
    Column
    getColumn(int index)
     
    Column
    getColumn(String columnName)
    Convenience method for retrieving a column by its name.
    Column
    getColumnByLabel(String columnLabel)
    Convenience method for retrieving a column by its label.
    DMFieldCollection
    getFieldCollection()
     
    String
    getSourceName()
    The underlying FC's source name.
    Boolean
    getUseRefreshData()
     
    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

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • 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

      public Boolean getUseRefreshData()

    • setUseRefreshData

      public void setUseRefreshData(Boolean useRefreshData)

    • getColumn

      public Column getColumn(String columnName)
      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 interface DatamartContext.Table
      Overrides:
      getColumn in class Table
      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

      public Column getColumn(int index)
      Specified by:
      getColumn in interface DatamartContext.Table
      Specified by:
      getColumn in interface Table
      Overrides:
      getColumn in class AbstractTable

    • getColumnByLabel

      public Column getColumnByLabel(String columnLabel)
      Description copied from interface: DatamartContext.Table
      Convenience method for retrieving a column by its label.
      Specified by:
      getColumnByLabel in interface DatamartContext.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

      public String 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 interface DatamartContext.Table
      Returns:
      The source name