org.kepler.objectmanager.data.db

Class Attribute

java.lang.Object

org.kepler.objectmanager.data.DataObjectDescription

org.kepler.objectmanager.data.db.Attribute

All Implemented Interfaces:

DSTableFieldIFace

public class Attribute
extends DataObjectDescription
implements DSTableFieldIFace

This object represents an Attribute. A Attribute stores information about a scalar value that is used in a Step in the pipeline.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOMUNIT unit type for custom units
static java.lang.String	STANDARDUNIT unit type for standard stmml units

Fields inherited from class org.kepler.objectmanager.data.DataObjectDescription

dataType, definition, id, missingValueCode, name

Constructor Summary

Constructors

Constructor and Description
Attribute(java.lang.String id, java.lang.String name, java.lang.String type) Construct a Attribute.
Attribute(java.lang.String id, java.lang.String name, java.lang.String type, java.lang.String description) Construct a Attribute.
Attribute(java.lang.String id, java.lang.String name, java.lang.String type, java.lang.String description, java.lang.String unit, Domain dom) Construct a Attribute.
Attribute(java.lang.String id, java.lang.String name, java.lang.String label, java.lang.String definition, java.lang.String unit, java.lang.String unitType, java.lang.String dataType, java.lang.String measurementScale, Domain dom) Constructor for extra local params

Method Summary

Modifier and Type	Method and Description
static java.lang.String	asLegalDbFieldName(java.lang.String attributeName) Given an attribute name, return a legal database field name.
Domain	getDomain() Returns the domain.
java.lang.String	getLabel() accessor method
java.lang.String	getMeasurementScale() accessor method
java.lang.String	getUnit() Return the unit for this Attribute
java.lang.String	getUnitType() accessor method
java.lang.String	toXml() Serialize the data item in XML format.

Methods inherited from class org.kepler.objectmanager.data.DataObjectDescription

addMissingValueCode, appendElement, equals, getDataType, getDefinition, getId, getMissingValueCode, getName, setDataType, setDefinition, setId, setMissingValueCode, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kepler.objectmanager.data.db.DSTableFieldIFace

addMissingValueCode, getDataType, getMissingValueCode, getName, setMissingValueCode

Field Detail

STANDARDUNIT

public static java.lang.String STANDARDUNIT

unit type for standard stmml units

CUSTOMUNIT

public static java.lang.String CUSTOMUNIT

unit type for custom units

Constructor Detail

Attribute

public Attribute(java.lang.String id,
                 java.lang.String name,
                 java.lang.String type)

Construct a Attribute.

Attribute

public Attribute(java.lang.String id,
                 java.lang.String name,
                 java.lang.String type,
                 java.lang.String description)

Construct a Attribute.

Attribute

public Attribute(java.lang.String id,
                 java.lang.String name,
                 java.lang.String type,
                 java.lang.String description,
                 java.lang.String unit,
                 Domain dom)

Construct a Attribute.

Attribute

public Attribute(java.lang.String id,
                 java.lang.String name,
                 java.lang.String label,
                 java.lang.String definition,
                 java.lang.String unit,
                 java.lang.String unitType,
                 java.lang.String dataType,
                 java.lang.String measurementScale,
                 Domain dom)

Constructor for extra local params

Parameters:

name - the name of the attribute

label - the label of the attribute

definition - the definition of the attribute

unit - the unit of the attribute

unitType - the type of the attribute. defined by STANDARDUNIT or CUSTOMUNIT

storageType - the data type of the attribute

measurementScale - the scale of the attribute

precision - the number of precise numbers to the right of the decimal

Method Detail

getUnit

public java.lang.String getUnit()

Return the unit for this Attribute

getLabel

public java.lang.String getLabel()

accessor method

getUnitType

public java.lang.String getUnitType()

accessor method

getMeasurementScale

public java.lang.String getMeasurementScale()

accessor method

getDomain

public Domain getDomain()

Returns the domain.

Returns:

Domain

toXml

public java.lang.String toXml()

Serialize the data item in XML format.

asLegalDbFieldName

public static java.lang.String asLegalDbFieldName(java.lang.String attributeName)

Given an attribute name, return a legal database field name. This is the generic implementation

Parameters:

attributeName - the attribute name

Returns:

legalName, a String containing a legal field name for this attribute name