com.tibco.rta.model

Interface RtaSchema

All Superinterfaces:

MetadataElement, java.io.Serializable

All Known Subinterfaces:

MutableRtaSchema

public interface RtaSchema
extends MetadataElement

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

Each DimensionHierarchy has an ordered list of Dimensions.

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

Method Summary

Methods

Modifier and Type	Method and Description
Fact	createFact() Create a new fact and associate it with this measurement.
Fact	createFact(java.lang.String uid) Create a new fact and associate it with this measurement.
Attribute	getAttribute(java.lang.String name) Gets the attribute in this measurement with this name.
java.util.Collection<Attribute>	getAttributes() Gets the attributes associated with this measurement
<T extends Cube> T	getCube(java.lang.String name) Gets a cube in this schema with this name or null if no such cube exists.
<T extends Cube> java.util.Collection<T>	getCubes() Gets all the cubes in the schema.
Dimension	getDimension(java.lang.String name) Gets the dimension in this measurement with this name.
java.util.Collection<Dimension>	getDimensions() Gets the dimensions associated with this measurement
java.lang.String	getDisplayName() get display name of schema
<T extends Measurement> T	getMeasurement(java.lang.String name) TODO documentation
<T extends Measurement> java.util.Collection<T>	getMeasurements() TODO documentation
java.util.Collection<RetentionPolicy>	getRetentionPolicies() TODO add documentation.
long	getVersion() TODO Add documentation.
boolean	isSystemSchema() whether this schema is system schema or not
java.lang.String	toXML() Convert this schema object to XML.

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

getDescription, getName, getOwnerSchema, getProperty, getPropertyNames, serialize

Method Detail

getAttributes

java.util.Collection<Attribute> getAttributes()

Gets the attributes associated with this measurement

Returns:

the attributes

getAttribute

Attribute getAttribute(java.lang.String name)

Gets the attribute in this measurement with this name.

Parameters:

name - The name to search

Returns:

the attribute

getDimensions

java.util.Collection<Dimension> getDimensions()

Gets the dimensions associated with this measurement

Returns:

the dimensions

getDimension

Dimension getDimension(java.lang.String name)

Gets the dimension in this measurement with this name.

Parameters:

name - The name to search

Returns:

the dimension

getMeasurements

<T extends Measurement> java.util.Collection<T> getMeasurements()

TODO documentation

Type Parameters:

T -

Returns:

getMeasurement

<T extends Measurement> T getMeasurement(java.lang.String name)

TODO documentation

Type Parameters:

T -

Parameters:

name -

Returns:

getCubes

<T extends Cube> java.util.Collection<T> getCubes()

Gets all the cubes in the schema.

Returns:

the cubes

getCube

<T extends Cube> T getCube(java.lang.String name)

Gets a cube in this schema with this name or null if no such cube exists.

Parameters:

name - The name to search for.

Returns:

the cube

getVersion

long getVersion()

TODO Add documentation.

Returns:

createFact

Fact createFact()

Create a new fact and associate it with this measurement.

Returns:

the newly created fact.

createFact

Fact createFact(java.lang.String uid)

Create a new fact and associate it with this measurement.

Parameters:

uid - : A unique identifier for fact key. If null or empty value is passed, a uid is generated.

Returns:

the newly created fact.

getRetentionPolicies

java.util.Collection<RetentionPolicy> getRetentionPolicies()

TODO add documentation.

Returns:

getDisplayName

java.lang.String getDisplayName()

get display name of schema

Specified by:

getDisplayName in interface MetadataElement

Returns:

display name of schema

toXML

java.lang.String toXML()
                       throws java.lang.Exception

Convert this schema object to XML.

Returns:

the xml string.

Throws:

java.lang.Exception

isSystemSchema

boolean isSystemSchema()

whether this schema is system schema or not

Returns:

true if its system schema