oracle.AWXML
Class Attribute

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Attribute

Direct Known Subclasses:

AttributeProjection

public class Attribute

extends BaseObject

implements DerivedMeasureInput

Specifies the basic characteristics of an attribute. An attribute represents a quality of a dimension member.

Attributes are generally used to help restrict the current set of active dimension members. Attribute values can be specified as a native datatype or given a domain of a dimension. When a dimension is the domain, the analytic workspace enforces the domain relationship, requiring all attribute values to be members of the associated dimension.

An attribute is defined on a dimension only, if the attribute is to be used at a lower level in the model, it is projected there using an AttributeProjection.

Attributes can have a classification. The valid list of classifications are:

   DEFAULT_ORDER
   END_DATE
   TIME_SPAN
   MEMBER_LONG_DESCRIPTION
   MEMBER_SHORT_DESCRIPTION
   MEMBER_VISIBLE
   USER

Attribute

public Attribute(BaseObject input)

This constructor is used by the Dimension Factory and can be used to create an instance of Attribute owned by the given Dimension.

Parameters:

input - A BaseObject which represents the owner of this object. An Attribute can currently be owned by only a Dimension

setDimensionDomain

public void setDimensionDomain(Dimension input)

Set the domain of an attribute to be a dimension. This allows a user to indicate that valid values of the attribute are supplied by the associated dimension. The system will enforce this constraint for the user. These types of attributes will also perform better than attributes with standard datatypes when the number of unique attribute values is small compared to the size of the owning dimension.

Parameters:

input - The Dimension to use as the domain of this attribute.

getDimensionDomain

public Dimension getDimensionDomain()

Return the Dimension referenced as the domain.

Returns:

A Dimension representing the domain.

setClassification

public void setClassification(java.lang.String input)

A classification system for Attributes is supplied to give some pre-determined meaning for specific attributes. The set of system recognized attribute classifications are:

   DEFAULT_ORDER
   END_DATE
   TIME_SPAN
   MEMBER_LONG_DESCRIPTION
   MEMBER_SHORT_DESCRIPTION
   MEMBER_VISIBLE
   USER

A classification of USER should be used to identify that an attribute is used by a foreign tool or application for its own purpose.

Parameters:

input - A String specifying the classification for the attribute

getClassification

public java.lang.String getClassification()

Return the assigned classification

Returns:

A String that represents the classification

setDataType

public void setDataType(java.lang.String input)

The datatype to use in the creation of the attribute. The valid datatypes are:

   TEXT
   INTEGER
   DECIMAL

Parameters:

input - A String containing the datatype of the attribute.

getDataType

public java.lang.String getDataType()

Returns the datatype assigned to the attribute.

Returns:

A String which represents the assigned datatype.

WriteToXML

public java.lang.String WriteToXML()

Returns the attribute instance as an XML String.

Overrides:

WriteToXML in class BaseObject

Returns:

A String which represents the object instance as XML.

Create

public java.lang.String Create(AWConnection connection)

Create this Attribute in the current analytic workspace.

Overrides:

Create in class BaseObject

Parameters:

connection - An AWConnection through which the command will be processed.

Returns:

A String indicating if the call was successful. A successful invocation returns the value 'success'.

Delete

public java.lang.String Delete(AWConnection connection)

Remove this attribute from the current analytic workspace.

Overrides:

Delete in class BaseObject

Parameters:

connection - An AWConnection through which the command will be processed

Returns:

A String indicating if the call was successful. A successful invocation returns the value 'success'.