com.tibco.rta.model.mutable
Interface MutableRtaSchema

All Superinterfaces:

MetadataElement, MutableMetadataElement, RtaSchema, java.io.Serializable

public interface MutableRtaSchema
extends MutableMetadataElement, RtaSchema

This is a logical collection of all related metrics artifacts like cubes and dimensions. A RtaSchema can have multiple MutableCubes. Each Cube defines a MutableMeasurement and one or more MutableDimensionHierarchys

Each DimensionHierarchy has an ordered list of Dimensions.

A Dimension is the attribute of the measurement over which a metric is aggregated.

Method Summary

void	addRetentionPolicy(java.lang.String qualifier, TimeUnits.Unit timUnit, int multiplier, java.lang.String purgeTimeOfDay, long purgeFrequencyPeriod)
Attribute	newAttribute(java.lang.String name, DataType dataType) Create a new attribute on this measurement.
MutableCube	newCube(java.lang.String name) Create a new MutableCube using the specified name.
Dimension	newDimension(Attribute attribute) Creates a new dimension and binds it with an attribute of the measurement.
Dimension	newDimension(java.lang.String name, Attribute attribute) Creates a new dimension and binds it with an attribute of the measurement.
MutableMeasurement	newMeasurement(java.lang.String name) Define the measurement for this schema.
TimeDimension	newTimeDimension(java.lang.String name, Attribute associatedAttribute, TimeUnits.Unit unit, int frequency) New time dimension.
Attribute	removeAttribute(java.lang.String name)
MutableCube	removeCube(java.lang.String name) Removes the cube.
Dimension	removeDimension(java.lang.String name) Removes the dimension from the measurement.
MutableMeasurement	removeMeasurement(java.lang.String name)
void	removeRetentionPolicy(java.lang.String qualifier)
void	setDisplayName(java.lang.String name) Set display name to schema

Methods inherited from interface com.tibco.rta.model.mutable.MutableMetadataElement

setDescription, setName, setProperty

Methods inherited from interface com.tibco.rta.model.RtaSchema

createFact, createFact, getAttribute, getAttributes, getCube, getCubes, getDimension, getDimensions, getDisplayName, getMeasurement, getMeasurements, getRetentionPolicies, getVersion, isSystemSchema, toXML

Methods inherited from interface com.tibco.rta.model.MetadataElement

getDescription, getName, getOwnerSchema, getProperty, getPropertyNames, serialize

Method Detail

newAttribute

Attribute newAttribute(java.lang.String name,
                       DataType dataType)
                       throws DuplicateSchemaElementException,
                              UndefinedSchemaElementException

Create a new attribute on this measurement. Attribute is a property of the measurement and will be used by facts to specify values to be used for computing metric.

Parameters:

name - Unique name for the attribute.

dataType - The datatype for legal values of this attribute

Returns:

newly created attribute

Throws:

DuplicateSchemaElementException - if an attribute with same name already exists.

UndefinedSchemaElementException

removeAttribute

Attribute removeAttribute(java.lang.String name)

newDimension

Dimension newDimension(java.lang.String name,
                       Attribute attribute)
                       throws DuplicateSchemaElementException,
                              UndefinedSchemaElementException

Creates a new dimension and binds it with an attribute of the measurement.

Parameters:

name - the name of the dimension. Optional parameter

attribute - the attribute to bind it with

Returns:

the dimension created

Throws:

DuplicateSchemaElementException - If a dimension with same name already exists in this measurement.

UndefinedSchemaElementException

newDimension

Dimension newDimension(Attribute attribute)
                       throws DuplicateSchemaElementException,
                              UndefinedSchemaElementException

Creates a new dimension and binds it with an attribute of the measurement. The name of the dimension will be the same as that of its attribute.

Parameters:

attribute - the attribute to bind it with

Returns:

the dimension created

Throws:

DuplicateSchemaElementException - If a dimension with same name already exists in this measurement.

UndefinedSchemaElementException

newTimeDimension

TimeDimension newTimeDimension(java.lang.String name,
                               Attribute associatedAttribute,
                               TimeUnits.Unit unit,
                               int frequency)
                               throws DuplicateSchemaElementException,
                                      UndefinedSchemaElementException

New time dimension.

Parameters:

name - the name

Returns:

the time dimension

Throws:

UndefinedSchemaElementException

DuplicateSchemaElementException

removeDimension

Dimension removeDimension(java.lang.String name)

Removes the dimension from the measurement.

Parameters:

dimension - the dimension

newMeasurement

MutableMeasurement newMeasurement(java.lang.String name)
                                  throws DuplicateSchemaElementException,
                                         UndefinedSchemaElementException

Define the measurement for this schema. Every cube in the schema will have a single measurement. e.g : Sales of car.

Parameters:

name -

Returns:

the newly created measurement.

Throws:

UndefinedSchemaElementException

DuplicateSchemaElementException

removeMeasurement

MutableMeasurement removeMeasurement(java.lang.String name)

newCube

MutableCube newCube(java.lang.String name)
                    throws DuplicateSchemaElementException,
                           UndefinedSchemaElementException

Create a new MutableCube using the specified name.

Parameters:

name - the name

Returns:

the cube

Throws:

DuplicateSchemaElementException - If a cube exists with this name in the schema.

UndefinedSchemaElementException

removeCube

MutableCube removeCube(java.lang.String name)

Removes the cube.

Parameters:

cube - the cube

Returns:

Return the removed cube

addRetentionPolicy

void addRetentionPolicy(java.lang.String qualifier,
                        TimeUnits.Unit timUnit,
                        int multiplier,
                        java.lang.String purgeTimeOfDay,
                        long purgeFrequencyPeriod)

removeRetentionPolicy

void removeRetentionPolicy(java.lang.String qualifier)

setDisplayName

void setDisplayName(java.lang.String name)

Set display name to schema

Specified by:

setDisplayName in interface MutableMetadataElement

Parameters:

display - name of schema