Style Intelligence v12.0

inetsoft.uql.asset
Class SortRef

java.lang.Object
  extended by inetsoft.uql.erm.AbstractDataRef
      extended by inetsoft.uql.asset.SortRef
All Implemented Interfaces:
AssetObject, DataRef, DataRefWrapper, inetsoft.util.DataSerializable, inetsoft.util.XMLSerializable, Serializable, Cloneable, Comparable

public class SortRef
extends AbstractDataRef
implements AssetObject, DataRefWrapper

Sort ref represents a sorted data ref.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.uql.erm.AbstractDataRef
chash, cname
 
Fields inherited from interface inetsoft.uql.erm.DataRef
AGG_CALC, CUBE, CUBE_DIMENSION, CUBE_MEASURE, CUBE_MODEL_DIMENSION, CUBE_MODEL_TIME_DIMENSION, CUBE_TIME_DIMENSION, DIMENSION, MEASURE, MODEL, NONE, TIME
 
Constructor Summary
SortRef()
          Constructor.
SortRef(DataRef ref)
          Constructor.
 
Method Summary
 SortRef copySortRef(DataRef ref)
          Copy sort ref.
 boolean equalsSort(Object obj)
          Check if equals another object.
 String getAttribute()
          Get the referenced attribute.
 Enumeration getAttributes()
          Get a list of all attributes that are referenced by this object.
 DataRef getDataRef()
          Get the contained data ref.
 String getDataType()
          Get the data type.
 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 getOrder()
          Get the sorting order.
 int getRefType()
          Get the type of the field.
 boolean isEntityBlank()
          Determine if the entity is blank.
 boolean isExpression()
          Check if the attribute is an expression.
protected  void parseAttributes(Element tag)
          Read in the attribute of this object from an XML tag.
protected  void parseContents(Element tag)
          Read in the contents of this object from an xml tag.
 boolean printKey(PrintWriter writer)
          Print the key to identify this content object.
 void refreshDataRef(ColumnSelection cols)
          Refresh the contained data ref.
 void setDataRef(DataRef ref)
          Set the contained data ref.
 void setOrder(int order)
          Set the sorting order.
 String toString()
          Get the string representation.
 String toView()
          Get the view representation of this field.
protected  void writeAttributes(PrintWriter writer)
          Write the attributes of this object.
protected  void writeAttributes2(DataOutputStream dos)
          Write the attributes of this object.
protected  void writeContents(PrintWriter writer)
          Write the contents of this object.
protected  void writeContents2(DataOutputStream dos)
          Write the contents of this object.
 
Methods inherited from class inetsoft.uql.erm.AbstractDataRef
addr, clone, compareTo, createDataRef, equals, equals, getClass, getDefaultFormula, getTypeNode, hashCode, isEmpty, parseCDATA, parseData, parseXML, writeCDATA, writeCDATA2, writeData, writeXML
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface inetsoft.uql.asset.AssetObject
clone
 
Methods inherited from interface inetsoft.uql.erm.DataRef
addr, clone, equals, getDefaultFormula, getTypeNode, isEmpty, parseData, writeData
 
Methods inherited from interface inetsoft.util.XMLSerializable
parseXML, writeXML
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

SortRef

public SortRef()
Constructor.


SortRef

public SortRef(DataRef ref)
Constructor.

Method Detail

copySortRef

public SortRef copySortRef(DataRef ref)
Copy sort ref.

Parameters:
ref - the specified data ref.
Returns:
the copied sort ref.

getRefType

public int getRefType()
Get the type of the field.

Specified by:
getRefType in interface DataRef
Returns:
the type of the field.

isExpression

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

Specified by:
isExpression in interface DataRef
Returns:
true if is an expression, false otherwise.

getEntity

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

Specified by:
getEntity in interface DataRef
Returns:
the name of the entity.

getEntities

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

Specified by:
getEntities in interface DataRef
Overrides:
getEntities in class AbstractDataRef
Returns:
an Enumeration with the name of the entity.

getAttribute

public String getAttribute()
Get the referenced attribute.

Specified by:
getAttribute in interface DataRef
Returns:
the name of the attribute.

getAttributes

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

Specified by:
getAttributes in interface DataRef
Overrides:
getAttributes in class AbstractDataRef
Returns:
an Enumeration containing AttributeRef objects.

isEntityBlank

public boolean isEntityBlank()
Determine if the entity is blank.

Specified by:
isEntityBlank in interface DataRef
Overrides:
isEntityBlank in class AbstractDataRef
Returns:
true if entity is null or blank.

getName

public String getName()
Get the name of the field.

Specified by:
getName in interface DataRef
Overrides:
getName in class AbstractDataRef
Returns:
the name of the field.

getDataRef

public DataRef getDataRef()
Get the contained data ref.

Specified by:
getDataRef in interface DataRefWrapper
Returns:
the contained data ref.

setDataRef

public void setDataRef(DataRef ref)
Set the contained data ref.

Specified by:
setDataRef in interface DataRefWrapper
Parameters:
ref - the contained data ref.

refreshDataRef

public void refreshDataRef(ColumnSelection cols)
Refresh the contained data ref.

Parameters:
cols - the specified column selection.

getDataType

public String getDataType()
Get the data type.

Specified by:
getDataType in interface DataRef
Overrides:
getDataType in class AbstractDataRef
Returns:
the data type defined in XSchema.

getOrder

public int getOrder()
Get the sorting order.

Returns:
the sorting order defined in XConstants.

setOrder

public void setOrder(int order)
Set the sorting order.

Parameters:
order - the specified sorting order defined in XConstants.

writeAttributes

protected void writeAttributes(PrintWriter writer)
Write the attributes of this object.

Specified by:
writeAttributes in class AbstractDataRef
Parameters:
writer - the output stream to which to write the XML data.

writeAttributes2

protected void writeAttributes2(DataOutputStream dos)
Write the attributes of this object.

Overrides:
writeAttributes2 in class AbstractDataRef
Parameters:
dos - the output stream to which to write the OutputStream data.

parseAttributes

protected void parseAttributes(Element tag)
                        throws Exception
Read in the attribute of this object from an XML tag.

Specified by:
parseAttributes in class AbstractDataRef
Parameters:
tag - the XML element representing this object.
Throws:
Exception

writeContents

protected void writeContents(PrintWriter writer)
Write the contents of this object.

Overrides:
writeContents in class AbstractDataRef
Parameters:
writer - the output stream to which to write the XML data.

writeContents2

protected void writeContents2(DataOutputStream dos)
Write the contents of this object.

Overrides:
writeContents2 in class AbstractDataRef
Parameters:
dos - the output stream to which to write the OutputStream data.

parseContents

protected void parseContents(Element tag)
                      throws Exception
Read in the contents of this object from an xml tag.

Overrides:
parseContents in class AbstractDataRef
Parameters:
tag - the specified xml element.
Throws:
Exception

printKey

public boolean printKey(PrintWriter writer)
                 throws Exception
Print the key to identify this content object. If the keys of two content objects are equal, the content objects are equal too.

Throws:
Exception

equalsSort

public boolean equalsSort(Object obj)
Check if equals another object.

Parameters:
obj - the specified object.
Returns:
true if yes, false otherwise.

toString

public String toString()
Get the string representation.

Overrides:
toString in class AbstractDataRef
Returns:
the string representation.

toView

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

Specified by:
toView in interface DataRef
Returns:
the view representation of this field.

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