Style Intelligence v12.0

inetsoft.uql.erm
Interface DataRef

All Superinterfaces:
Cloneable, Comparable, inetsoft.util.DataSerializable, Serializable, inetsoft.util.XMLSerializable
All Known Subinterfaces:
CalcAggregate, CalcGroup, CompositeDataRef, DataRefWrapper, IAggregateRef, RangeRef
All Known Implementing Classes:
AbstractDataRef, AggregateRef, AliasDataRef, AttributeRef, ColumnRef, DateRangeRef, ExprAttributeRef, ExpressionRef, ExpressionRef2, GroupRef, NamedRangeRef, NumericRangeRef, SortRef

public interface DataRef
extends Cloneable, Serializable, inetsoft.util.XMLSerializable, Comparable, inetsoft.util.DataSerializable

DataRef holding a reference to a SQL expression or an attribute.


Field Summary
static int AGG_CALC
          Calculate based on aggregate value.
static int CUBE
          Cube data ref.
static int CUBE_DIMENSION
          Cube dimension data ref.
static int CUBE_MEASURE
          Cube measure data ref.
static int CUBE_MODEL_DIMENSION
          Cube model dimension data ref.
static int CUBE_MODEL_TIME_DIMENSION
          Cube model time dimension data ref.
static int CUBE_TIME_DIMENSION
          Cube time dimension data ref.
static int DIMENSION
          Dimension data ref.
static int MEASURE
          Measure data ref.
static int MODEL
          Model cube data ref.
static int NONE
          Normal data ref.
static int TIME
          Time dimension data ref.
 
Method Summary
 int addr()
          Get the address.
 Object clone()
          Create a copy of this object.
 boolean equals(Object obj, boolean strict)
          Compare two column refs.
 String getAttribute()
          Get the referenced attribute.
 Enumeration getAttributes()
          Get a list of all attributes that are referenced by this object.
 String getDataType()
          Get the data type.
 String getDefaultFormula()
          Get the default formula.
 Enumeration getEntities()
          Get the attribute's parent entity.
 String getEntity()
          Get the attribute's parent entity.
 String getName()
          Get the name of the field.
 int getRefType()
          Get the ref type.
 XTypeNode getTypeNode()
          Get the type node.
 boolean isEmpty()
          Check if the data ref is blank.
 boolean isEntityBlank()
          Determine if the entity is blank.
 boolean isExpression()
          Check if the attribute is an expression.
 boolean parseData(DataInputStream input)
          Parse data from an InputStream.
 String toView()
          Get the view representation of this field.
 void writeData(DataOutputStream output)
          Write data to a DataOutputStream.
 
Methods inherited from interface inetsoft.util.XMLSerializable
parseXML, writeXML
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

NONE

static final int NONE
Normal data ref.

See Also:
Constant Field Values

DIMENSION

static final int DIMENSION
Dimension data ref.

See Also:
Constant Field Values

MEASURE

static final int MEASURE
Measure data ref.

See Also:
Constant Field Values

CUBE

static final int CUBE
Cube data ref.

See Also:
Constant Field Values

MODEL

static final int MODEL
Model cube data ref.

See Also:
Constant Field Values

TIME

static final int TIME
Time dimension data ref.

See Also:
Constant Field Values

CUBE_DIMENSION

static final int CUBE_DIMENSION
Cube dimension data ref.

See Also:
Constant Field Values

CUBE_MEASURE

static final int CUBE_MEASURE
Cube measure data ref.

See Also:
Constant Field Values

CUBE_TIME_DIMENSION

static final int CUBE_TIME_DIMENSION
Cube time dimension data ref.

See Also:
Constant Field Values

CUBE_MODEL_DIMENSION

static final int CUBE_MODEL_DIMENSION
Cube model dimension data ref.

See Also:
Constant Field Values

CUBE_MODEL_TIME_DIMENSION

static final int CUBE_MODEL_TIME_DIMENSION
Cube model time dimension data ref.

See Also:
Constant Field Values

AGG_CALC

static final int AGG_CALC
Calculate based on aggregate value.

See Also:
Constant Field Values
Method Detail

getRefType

int getRefType()
Get the ref type.

Returns:
the ref type, one of NONE, DIMENSION and MEASURE.

getDefaultFormula

String getDefaultFormula()
Get the default formula.


isExpression

boolean isExpression()
Check if the attribute is an expression.

Returns:
true if is an expression, false otherwise.

isEmpty

boolean isEmpty()
Check if the data ref is blank.

Returns:
true if blank, false otherwise.

getEntity

String getEntity()
Get the attribute's parent entity.

Returns:
the name of the entity.

getEntities

Enumeration getEntities()
Get the attribute's parent entity.

Returns:
an Enumeration with the name of the entity.

getAttribute

String getAttribute()
Get the referenced attribute.

Returns:
the name of the attribute.

getAttributes

Enumeration getAttributes()
Get a list of all attributes that are referenced by this object.

Returns:
an Enumeration containing AttributeRef objects.

isEntityBlank

boolean isEntityBlank()
Determine if the entity is blank.

Returns:
true if entity is null or entity is equal to empty string ("").

getName

String getName()
Get the name of the field.

Returns:
the name of the field.

getDataType

String getDataType()
Get the data type.

Returns:
the data type defined in XSchema.

getTypeNode

XTypeNode getTypeNode()
Get the type node.

Returns:
the type node of the column ref.

toView

String toView()
Get the view representation of this field.

Returns:
the view representation of this field.

clone

Object clone()
Create a copy of this object.

Returns:
a copy of this object.

equals

boolean equals(Object obj,
               boolean strict)
Compare two column refs.

Parameters:
strict - true to compare all properties of ColumnRef. Otherwise only entity and attribute are compared.

writeData

void writeData(DataOutputStream output)
               throws IOException
Write data to a DataOutputStream.

Specified by:
writeData in interface inetsoft.util.DataSerializable
Parameters:
output - the destination DataOutputStream.
Throws:
IOException.
IOException

parseData

boolean parseData(DataInputStream input)
Parse data from an InputStream.

Specified by:
parseData in interface inetsoft.util.DataSerializable
Parameters:
input - the source DataInputStream.
Returns:
true if successfully parsed, false otherwise.

addr

int addr()
Get the address.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.