com.sas.metadata.remote
Interface CalculatedMeasure

All Superinterfaces:

CMetadata, Feature, LogicalColumn, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Measure, PrimaryType, java.rmi.Remote, Root

public interface CalculatedMeasure
extends Measure

In a dimension, a member whose value is derived from the values of other members.

Attributes of CalculatedMeasure are:

• Expression

Associations of CalculatedMeasure are:

Usage

To create an instance of this CalculatedMeasure, use the factory create methods.
Example: create a CalculatedMeasure with name "CalculatedMeasure_Object", in repository "AAAAAAAA".

 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 CalculatedMeasure myObject = (CalculatedMeasure) factory.createComplexMetadataObject(objectStore, "CalculatedMeasure_Object", MetadataObjects.CALCULATEDMEASURE, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed
 

Behavior

• Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
• When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
• If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:

9.0

Field Summary

static java.lang.String

ATTRIBUTE_EXPRESSION_NAME Constant used for the name of the Expression attribute.

Fields inherited from interface com.sas.metadata.remote.Measure

ASSOCIATION_CUBES_NAME, ASSOCIATION_OWNINGDIMENSION_NAME, ATTRIBUTE_ISSTOREDSTATISTIC_NAME, ATTRIBUTE_STATISTIC_NAME, ATTRIBUTE_UNIQUENAME_NAME, ATTRIBUTE_UNITS_NAME

Fields inherited from interface com.sas.metadata.remote.LogicalColumn

ATTRIBUTE_COLUMNLENGTH_NAME, ATTRIBUTE_COLUMNNAME_NAME, ATTRIBUTE_COLUMNTYPE_NAME, ATTRIBUTE_SASFORMAT_NAME, ATTRIBUTE_SASINFORMAT_NAME

Fields inherited from interface com.sas.metadata.remote.Feature

ASSOCIATION_SOURCEFEATUREMAPS_NAME, ASSOCIATION_TARGETFEATUREMAPS_NAME

Fields inherited from interface com.sas.metadata.remote.PrimaryType

ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_NAME

Fields inherited from interface com.sas.metadata.remote.Root

ASSOCIATION_ACCESSCONTROLS_NAME, ASSOCIATION_CHANGES_NAME, ASSOCIATION_CUSTOMASSOCIATIONS_NAME, ASSOCIATION_DOCUMENTS_NAME, ASSOCIATION_EXTENSIONS_NAME, ASSOCIATION_EXTERNALIDENTITIES_NAME, ASSOCIATION_GROUPS_NAME, ASSOCIATION_IMPLEMENTORS_NAME, ASSOCIATION_KEYWORDS_NAME, ASSOCIATION_LOCALIZEDATTRIBUTES_NAME, ASSOCIATION_NOTES_NAME, ASSOCIATION_PRIMARYPROPERTYGROUP_NAME, ASSOCIATION_PROMPTS_NAME, ASSOCIATION_PROPERTIES_NAME, ASSOCIATION_PROPERTYSETS_NAME, ASSOCIATION_REFERENCEDOBJECTS_NAME, ASSOCIATION_RESPONSIBLEPARTIES_NAME, ASSOCIATION_SOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECSOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECTARGETTRANSFORMATIONS_NAME, ASSOCIATION_TARGETTRANSFORMATIONS_NAME, ASSOCIATION_TIMESTAMPS_NAME, ASSOCIATION_TREES_NAME, ASSOCIATION_TSOBJECTNAMESPACE_NAME, ASSOCIATION_USEDBYPROTOTYPES_NAME, ASSOCIATION_USINGPROTOTYPE_NAME, ASSOCIATION_VARIABLES_NAME, ATTRIBUTE_CHANGESTATE_NAME, ATTRIBUTE_LOCKEDBY_NAME, ATTRIBUTE_USAGEVERSION_NAME

Fields inherited from interface com.sas.metadata.remote.MdObjectBase

ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME

Method Summary

java.lang.String	getExpression() Gets the String value of Expression
int	getExpressionMaxLength() Gets the maximum length of Expression
int	getExpressionState() Gets the Metadata State of Expression
void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are:
void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are:
void	setExpression(java.lang.String inExpression) Sets the Expression value and sets the state to MetadataState.LOCAL.
void	setExpression(java.lang.String inExpression, int state) Sets the Expression Metadata State.
void	setExpressionState(int state) Sets the Metadata State of Expression.

Methods inherited from interface com.sas.metadata.remote.Measure

getCubes, getCubes, getIsStoredStatistic, getIsStoredStatisticState, getOwningDimension, getOwningDimensions, getOwningDimensions, getStatistic, getStatisticMaxLength, getStatisticState, getUniqueName, getUniqueNameMaxLength, getUniqueNameState, getUnits, getUnitsMaxLength, getUnitsState, setCubes, setCubes, setIsStoredStatistic, setIsStoredStatistic, setIsStoredStatistic, setIsStoredStatistic, setIsStoredStatisticState, setOwningDimension, setOwningDimensions, setOwningDimensions, setStatistic, setStatistic, setStatisticState, setUniqueName, setUniqueName, setUniqueNameState, setUnits, setUnits, setUnitsState

Methods inherited from interface com.sas.metadata.remote.LogicalColumn

getColumnLength, getColumnLengthState, getColumnName, getColumnNameMaxLength, getColumnNameState, getColumnType, getColumnTypeState, getSASFormat, getSASFormatMaxLength, getSASFormatState, getSASInformat, getSASInformatMaxLength, getSASInformatState, setColumnLength, setColumnLength, setColumnLength, setColumnLength, setColumnLengthState, setColumnName, setColumnName, setColumnNameState, setColumnType, setColumnType, setColumnType, setColumnType, setColumnTypeState, setSASFormat, setSASFormat, setSASFormatState, setSASInformat, setSASInformat, setSASInformatState

Methods inherited from interface com.sas.metadata.remote.Feature

getSourceFeatureMaps, getSourceFeatureMaps, getTargetFeatureMaps, getTargetFeatureMaps, setSourceFeatureMaps, setSourceFeatureMaps, setTargetFeatureMaps, setTargetFeatureMaps

Methods inherited from interface com.sas.metadata.remote.PrimaryType

getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeState

Methods inherited from interface com.sas.metadata.remote.Root

getAccessControls, getAccessControls, getChanges, getChanges, getChangeState, getChangeStateMaxLength, getChangeStateState, getCustomAssociations, getCustomAssociations, getDocuments, getDocuments, getExtensions, getExtensions, getExternalIdentities, getExternalIdentities, getGroups, getGroups, getImplementors, getImplementors, getKeywords, getKeywords, getLocalizedAttributes, getLocalizedAttributes, getLockedBy, getLockedByMaxLength, getLockedByState, getNotes, getNotes, getPrimaryPropertyGroup, getPrimaryPropertyGroups, getPrimaryPropertyGroups, getPrompts, getPrompts, getProperties, getProperties, getPropertySets, getPropertySets, getReferencedObjects, getReferencedObjects, getResponsibleParties, getResponsibleParties, getSourceTransformations, getSourceTransformations, getSpecSourceTransformations, getSpecSourceTransformations, getSpecTargetTransformations, getSpecTargetTransformations, getTargetTransformations, getTargetTransformations, getTimestamps, getTimestamps, getTrees, getTrees, getTSObjectNamespace, getTSObjectNamespaces, getTSObjectNamespaces, getUsageVersion, getUsageVersionState, getUsedByPrototypes, getUsedByPrototypes, getUsingPrototype, getUsingPrototypes, getUsingPrototypes, getVariables, getVariables, setAccessControls, setAccessControls, setChanges, setChanges, setChangeState, setChangeState, setChangeStateState, setCustomAssociations, setCustomAssociations, setDocuments, setDocuments, setExtensions, setExtensions, setExternalIdentities, setExternalIdentities, setGroups, setGroups, setImplementors, setImplementors, setKeywords, setKeywords, setLocalizedAttributes, setLocalizedAttributes, setLockedBy, setLockedBy, setLockedByState, setNotes, setNotes, setPrimaryPropertyGroup, setPrimaryPropertyGroups, setPrimaryPropertyGroups, setPrompts, setPrompts, setProperties, setProperties, setPropertySets, setPropertySets, setReferencedObjects, setReferencedObjects, setResponsibleParties, setResponsibleParties, setSourceTransformations, setSourceTransformations, setSpecSourceTransformations, setSpecSourceTransformations, setSpecTargetTransformations, setSpecTargetTransformations, setTargetTransformations, setTargetTransformations, setTimestamps, setTimestamps, setTrees, setTrees, setTSObjectNamespace, setTSObjectNamespaces, setTSObjectNamespaces, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersionState, setUsedByPrototypes, setUsedByPrototypes, setUsingPrototype, setUsingPrototypes, setUsingPrototypes, setVariables, setVariables

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML

closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil

addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIds

Methods inherited from interface com.sas.metadata.remote.MdObjectBase

addElementToChangeList, clearChangeList, getChangeList, getCMetadataType, getDesc, getDescMaxLength, getDescState, getFQID, getId, getIdState, getMetadataCreated, getMetadataCreatedState, getMetadataUpdated, getMetadataUpdatedState, getName, getNameMaxLength, getNameState, getObjectStore, getPredAssociations, getRepositoryID, getRequiredAssociations, getState, isAssociationRequired, isNewObject, isPredAssociation, removeElementFromChangeList, resetObject, resetState, resetStates, setCMetadataType, setDesc, setDesc, setDescState, setFQID, setFQID, setId, setId, setIdState, setMetadataCreated, setMetadataCreated, setMetadataCreatedState, setMetadataUpdated, setMetadataUpdated, setMetadataUpdatedState, setName, setName, setNameState, setObjectStore, setState

Field Detail

ATTRIBUTE_EXPRESSION_NAME

static final java.lang.String ATTRIBUTE_EXPRESSION_NAME

Constant used for the name of the Expression attribute.

Expression: The formula.

See Also:

Constant Field Values

Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.RemoteException

(S) This initializes the Required Objects(Roles) which are:

Specified by:

initializeRequiredObjects in interface Feature

Specified by:

initializeRequiredObjects in interface LogicalColumn

Specified by:

initializeRequiredObjects in interface MdObjectBaseUtil

Specified by:

initializeRequiredObjects in interface Measure

Specified by:

initializeRequiredObjects in interface PrimaryType

Specified by:

initializeRequiredObjects in interface Root

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

initializePredObjects

void initializePredObjects()
                           throws java.rmi.RemoteException

(S) Adds the Associated objects to the predObjects which are:

Specified by:

initializePredObjects in interface Feature

Specified by:

initializePredObjects in interface LogicalColumn

Specified by:

initializePredObjects in interface MdObjectBase

Specified by:

initializePredObjects in interface Measure

Specified by:

initializePredObjects in interface PrimaryType

Specified by:

initializePredObjects in interface Root

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getExpression

java.lang.String getExpression()
                               throws java.rmi.RemoteException

Gets the String value of Expression

Returns:

The Expression

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getExpressionState

int getExpressionState()
                       throws java.rmi.RemoteException

Gets the Metadata State of Expression

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getExpressionMaxLength

int getExpressionMaxLength()
                           throws java.rmi.RemoteException

Gets the maximum length of Expression

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

setExpression

void setExpression(java.lang.String inExpression)
                   throws java.rmi.RemoteException

Sets the Expression value and sets the state to MetadataState.LOCAL.

Parameters:

inExpression - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setExpression

void setExpression(java.lang.String inExpression,
                   int state)
                   throws java.rmi.RemoteException

Sets the Expression Metadata State.

Parameters:

inExpression - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setExpressionState

void setExpressionState(int state)
                        throws java.rmi.RemoteException

Sets the Metadata State of Expression.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.