org.apache.lens.cube.metadata

Interface CubeInterface

All Superinterfaces:

Named

All Known Implementing Classes:

Cube, DerivedCube

public interface CubeInterface
extends Named

The cube interface on which queries can be accepted

Method Summary

Modifier and Type	Method and Description
boolean	allFieldsQueriable() Whether all the fields of cube can be queried.
Set<String>	getAllFieldNames() Get all field names reachable from cube
JoinChain	getChainByName(String chainName) Get joinchain by given by name
CubeColumn	getColumnByName(String colName) Get cube column given by column name.
CubeDimAttribute	getDimAttributeByName(String dimAttrName) Get dimension attribute given by name
Set<String>	getDimAttributeNames() Get all dimension attribute names
Set<CubeDimAttribute>	getDimAttributes() Get all dimension attributes of the cube
ExprColumn	getExpressionByName(String exprName) Get expression by given by name
Set<String>	getExpressionNames() Get all expression names
Set<ExprColumn>	getExpressions() Get all expressions defined on the cube
Set<String>	getJoinChainNames() Get all join chain names
Set<JoinChain>	getJoinChains() Get all joinchains defined on the cube
CubeMeasure	getMeasureByName(String msrName) Get measure by given by name
Set<String>	getMeasureNames() Get all measure names
Set<CubeMeasure>	getMeasures() Get all measures of the cube
Set<String>	getTimedDimensions() Get all timed dimensions of cube
boolean	isDerivedCube() Is the cube a derived cube or base cube

Methods inherited from interface org.apache.lens.cube.metadata.Named

getName

Method Detail

getMeasures

Set<CubeMeasure> getMeasures()

Get all measures of the cube

Returns:

set of CubeMeasure

getDimAttributes

Set<CubeDimAttribute> getDimAttributes()

Get all dimension attributes of the cube

Returns:

set CubeDimAttribute

getExpressions

Set<ExprColumn> getExpressions()

Get all expressions defined on the cube

Returns:

set ExprColumn

getJoinChains

Set<JoinChain> getJoinChains()

Get all joinchains defined on the cube

Returns:

set JoinChain

getDimAttributeByName

CubeDimAttribute getDimAttributeByName(String dimAttrName)

Get dimension attribute given by name

Parameters:

dimAttrName - dimension attribute name

Returns:

A CubeDimAttribute object

getMeasureByName

CubeMeasure getMeasureByName(String msrName)

Get measure by given by name

Parameters:

msrName - Measure name

Returns:

A CubeMeasure object

getExpressionByName

ExprColumn getExpressionByName(String exprName)

Get expression by given by name

Parameters:

exprName - Expression name

Returns:

A ExprColumn object

getChainByName

JoinChain getChainByName(String chainName)

Get joinchain by given by name

Parameters:

chainName - Chain name

Returns:

A JoinChain object

getColumnByName

CubeColumn getColumnByName(String colName)

Get cube column given by column name.

It can be a measure, dimension attribute or an expression.

Parameters:

colName - Column name

Returns:

A CubeColumn object

getTimedDimensions

Set<String> getTimedDimensions()

Get all timed dimensions of cube

Returns:

Set of strings

isDerivedCube

boolean isDerivedCube()

Is the cube a derived cube or base cube

Returns:

true if cube is derived, false if it is base

getMeasureNames

Set<String> getMeasureNames()

Get all measure names

Returns:

Set of strings

getDimAttributeNames

Set<String> getDimAttributeNames()

Get all dimension attribute names

Returns:

Set of strings

getJoinChainNames

Set<String> getJoinChainNames()

Get all join chain names

Returns:

Set of strings

getExpressionNames

Set<String> getExpressionNames()

Get all expression names

Returns:

Set of strings

getAllFieldNames

Set<String> getAllFieldNames()

Get all field names reachable from cube

Returns:

Set of strings

allFieldsQueriable

boolean allFieldsQueriable()

Whether all the fields of cube can be queried.

If false, the fields can queried through derived cubes. Users can look at derived cube fields to know which all fields can be queried together.

If true, all the fields can be directly queried.

Returns:

true or false