com.sas.dataselectors.calculateditems
Interface CalculatedObjectFactoryInterface

All Superinterfaces:

CalculatedItemMetadataInterface

All Known Implementing Classes:

BaseCalculatedObjectFactory, BusinessModelCalculatedObjectFactory, BusinessQueryCalculatedObjectFactory, DataSelectionCalculatedObjectFactory, InformationMapCalculatedObjectFactory

public interface CalculatedObjectFactoryInterface
extends CalculatedItemMetadataInterface

Description: Interface defining calls to the CalculatedObjectFactory Copyright: Copyright (c) 2002 Company: SAS

Nested Class Summary

static interface

CalculatedObjectFactoryInterface.ImageIconFactoryInterface

Method Summary

abstract boolean	canBusinessModelObjectHaveChildren(java.lang.Object parent)
abstract boolean	canBusinessModelObjectHaveValues(java.lang.Object bmObject)
abstract boolean	canRemoveAllCalculatedItems()
abstract com.sas.expressions.visuals.DataSourceTreeInterface	getBusinessDataSourceTree() Get the DataSource tree model from the Business (Data Item) view of the business model
abstract java.util.List	getBusinessModelCalculatedItemObjects(boolean includeBaseModels)
abstract java.util.List	getBusinessModelObjectChildren(java.lang.Object parent)
abstract java.lang.String	getBusinessModelObjectImageName(java.lang.Object value, boolean expanded)
abstract java.util.List	getBusinessModelObjectValues(java.lang.Object bmObject)
abstract java.lang.String	getBusinessModelObjectValuesToInsert(java.lang.Object item)
abstract java.lang.String	getBusinessObjectDescription(java.lang.Object item)
abstract java.lang.String	getBusinessObjectDisplayName(java.lang.Object item)
abstract java.lang.String	getBusinessObjectInsertName(java.lang.Object item)
abstract java.lang.String	getBusinessObjectTipText(java.lang.Object item)
abstract java.util.List	getChildFormats(java.lang.String expressionText, int expressionType, int restrictByType)
abstract java.util.List	getDataItems(boolean includeBaseModels)
abstract java.util.List	getDataItemsAndFolders(boolean includeBaseModels)
abstract java.util.List	getDataSources(boolean includeBaseModels)
abstract com.sas.expressions.visuals.DataSourceTreeInterface	getDataSourceTree() Get the Default DataSource tree model for this business model
abstract java.lang.String[]	getExpressionTypeNames()
abstract int[]	getExpressionTypeValues()
abstract java.lang.String	getExpressionUtilText(com.sas.iquery.metadata.expr.ExpressionInterface expression)
abstract java.lang.String	getFormatFromResources(java.lang.Object dataItem)
abstract com.sas.expressions.visuals.FunctionTreeInterface	getFunctionListTree() Get the Category Tree with Function Lists model
abstract javax.swing.Icon	getImageIconFromIqVisualsBundle(java.lang.String imageName)
abstract java.lang.String	getLastInvalidCalculatedItemMessage()
abstract java.lang.Exception	getLastInvalidExpressionException()
abstract boolean	getLevelHasMembers() Determines if the levels of data contained by this adapter have members or not.
abstract java.util.Map	getLevelNameMap(boolean includeHierarchyName) Gets the level names in a map with the Level Display names as the keys and the insertable text as the values.
abstract java.lang.String[]	getLevelNames(boolean includeHierarchyName) Gets the level names.
abstract java.util.Map	getMeasureNameMap() Gets the measure names and each insertable value.
abstract java.lang.String[]	getMeasureNames() Gets the measure names.
abstract java.lang.String[]	getMemberNames(java.lang.String levelName) Get the member names for a given level.
abstract com.sas.expressions.visuals.OperationListInterface	getOperationList() Get the Operations List model
abstract com.sas.expressions.visuals.DataSourceTreeInterface	getPhysicalDataSourceTree() Get the DataSource tree model from the Physical view of the business model
abstract com.sas.expressions.visuals.DataSourceTreeInterface	getPromptDataSourceTree() Get the DataSource tree model containing the prompts of the business model
abstract com.sas.iquery.metadata.expr.ResourceScope	getResourceScope()
abstract java.lang.Object	newBusinessModelCalculatedItemObject()
abstract java.lang.Object	newBusinessModelCalculatedItemObject(CalculatedItemInterface item)
abstract CalculatedItemInterface	newCalculatedItem(CalculatedItemInterface toBeCloned)
abstract CalculatedItemInterface	newCalculatedItemFromBusinessObject(java.lang.Object bmObject)
abstract com.sas.iquery.metadata.expr.ExpressionInterface	newExpressionUtilExpression(java.lang.String text, int type)
abstract void	removeBusinessModelCalculatedItemObject(java.lang.Object item)
abstract void	setResourceScope(com.sas.iquery.metadata.expr.ResourceScope scope)
abstract boolean	updateBusinessModelObjectFromCalculatedItem(java.lang.Object bmObject, CalculatedItemInterface item)
abstract boolean	updateCalculatedItemFromBusinessModelObject(CalculatedItemInterface item, java.lang.Object bmObject)
abstract boolean	updateCalculatedItemFromCalcValues(CalculatedItemInterface item, java.lang.String id, java.lang.String label, java.lang.String desc, int calcType, java.lang.String text)
abstract boolean	updateCalculatedItemFromExprValues(CalculatedItemInterface item, java.lang.String id, java.lang.String label, java.lang.String desc, int exprType, java.lang.String text)
abstract boolean	validateCalculatedItem(CalculatedItemInterface item)
abstract boolean	validateCalculatedItem(CalculatedItemInterface item, boolean validateText)
abstract boolean	validateItemCalculation(CalculatedItemInterface item)

Methods inherited from interface com.sas.dataselectors.calculateditems.CalculatedItemMetadataInterface

getMaxOutputObservations, setMaxOutputObservations

Method Detail

getLevelHasMembers

boolean getLevelHasMembers()

Description copied from interface: CalculatedItemMetadataInterface

Determines if the levels of data contained by this adapter have members or not.

Specified by:

getLevelHasMembers in interface CalculatedItemMetadataInterface

Returns:

true if this adapter contains data with members; false otherwise.

See Also:

CalculatedItemMetadataInterface.getMemberNames(String)

getLevelNameMap

java.util.Map getLevelNameMap(boolean includeHierarchyName)

Description copied from interface: CalculatedItemMetadataInterface

Gets the level names in a map with the Level Display names as the keys and the insertable text as the values.

Specified by:

getLevelNameMap in interface CalculatedItemMetadataInterface

Parameters:

includeHierarchyName - set to true if the hierarchy name for a given level is to be returned (only used if getLevelHasMembers() is true)

Returns:

a map of String containing the names of the levels, and optionally, the hierarchy name for each level to the insertable text

See Also:

CalculatedItemMetadataInterface.getLevelHasMembers()

getLevelNames

java.lang.String[] getLevelNames(boolean includeHierarchyName)

Description copied from interface: CalculatedItemMetadataInterface

Gets the level names. Level names are level names for OLAP, but are character type data items for relational.

Specified by:

getLevelNames in interface CalculatedItemMetadataInterface

Parameters:

includeHierarchyName - set to true if the hierarchy name for a given level is to be returned (only used if getLevelHasMembers() is true)

Returns:

an array of String containing the names of the levels, and optionally, the hierarchy name for each level.

See Also:

CalculatedItemMetadataInterface.getLevelHasMembers()

getMeasureNameMap

java.util.Map getMeasureNameMap()

Description copied from interface: CalculatedItemMetadataInterface

Gets the measure names and each insertable value. Measure names are actual names of measures for OLAP, but are numeric type data items for relational.

Specified by:

getMeasureNameMap in interface CalculatedItemMetadataInterface

Returns:

an map of String containing the names of the measures mapped to the insertable value

getMeasureNames

java.lang.String[] getMeasureNames()

Description copied from interface: CalculatedItemMetadataInterface

Gets the measure names. Measure names are actual names of measures for OLAP, but are numeric type data items for relational.

Specified by:

getMeasureNames in interface CalculatedItemMetadataInterface

Returns:

an array of String containing the names of the measures

getMemberNames

java.lang.String[] getMemberNames(java.lang.String levelName)

Description copied from interface: CalculatedItemMetadataInterface

Get the member names for a given level. This method is only meaningful in the case where the level of data contains members (i.e. if getLevelHasMembers() returns true).

Specified by:

getMemberNames in interface CalculatedItemMetadataInterface

Parameters:

levelName - the level for which to get the member names

Returns:

an array of Strings containing the names of the members for the specified level if the adapter contains OLAP data; returns null otherwise.

See Also:

CalculatedItemMetadataInterface.getLevelHasMembers()

getDataSourceTree

com.sas.expressions.visuals.DataSourceTreeInterface getDataSourceTree()

Description copied from interface: CalculatedItemMetadataInterface

Get the Default DataSource tree model for this business model

Specified by:

getDataSourceTree in interface CalculatedItemMetadataInterface

Returns:

a com.sas.expressions.visuals.DataSourceTreeInterface containing the data sources that can be added in the Expression Editor (null allowed if not supported)

getPhysicalDataSourceTree

com.sas.expressions.visuals.DataSourceTreeInterface getPhysicalDataSourceTree()

Description copied from interface: CalculatedItemMetadataInterface

Get the DataSource tree model from the Physical view of the business model

Specified by:

getPhysicalDataSourceTree in interface CalculatedItemMetadataInterface

Returns:

a com.sas.expressions.visuals.DataSourceTreeInterface containing the data sources that can be added in the Expression Editor (null allowed if not supported)

getBusinessDataSourceTree

com.sas.expressions.visuals.DataSourceTreeInterface getBusinessDataSourceTree()

Description copied from interface: CalculatedItemMetadataInterface

Get the DataSource tree model from the Business (Data Item) view of the business model

Specified by:

getBusinessDataSourceTree in interface CalculatedItemMetadataInterface

Returns:

a com.sas.expressions.visuals.DataSourceTreeInterface containing the data sources that can be added in the Expression Editor (null allowed if not supported)

getPromptDataSourceTree

com.sas.expressions.visuals.DataSourceTreeInterface getPromptDataSourceTree()

Description copied from interface: CalculatedItemMetadataInterface

Get the DataSource tree model containing the prompts of the business model

Specified by:

getPromptDataSourceTree in interface CalculatedItemMetadataInterface

Returns:

a com.sas.expressions.visuals.DataSourceTreeInterface containing the data sources that can be added in the Expression Editor (null allowed if not supported)

getFunctionListTree

com.sas.expressions.visuals.FunctionTreeInterface getFunctionListTree()

Description copied from interface: CalculatedItemMetadataInterface

Get the Category Tree with Function Lists model

Specified by:

getFunctionListTree in interface CalculatedItemMetadataInterface

Returns:

a com.sas.expressions.visuals.FunctionTreeInterface containing the Categories with Functions that can be added in the Expression Editor (null allowed if not supported)

getOperationList

com.sas.expressions.visuals.OperationListInterface getOperationList()

Description copied from interface: CalculatedItemMetadataInterface

Get the Operations List model

Specified by:

getOperationList in interface CalculatedItemMetadataInterface

Returns:

a com.sas.expressions.visuals.OperationListInterface containing the Operations that can be added in the Expression Editor (null allowed if not supported)

getDataItems

java.util.List getDataItems(boolean includeBaseModels)

getBusinessModelCalculatedItemObjects

java.util.List getBusinessModelCalculatedItemObjects(boolean includeBaseModels)

removeBusinessModelCalculatedItemObject

void removeBusinessModelCalculatedItemObject(java.lang.Object item)

newBusinessModelCalculatedItemObject

java.lang.Object newBusinessModelCalculatedItemObject()

newBusinessModelCalculatedItemObject

java.lang.Object newBusinessModelCalculatedItemObject(CalculatedItemInterface item)

updateCalculatedItemFromBusinessModelObject

boolean updateCalculatedItemFromBusinessModelObject(CalculatedItemInterface item,
                                                    java.lang.Object bmObject)

updateBusinessModelObjectFromCalculatedItem

boolean updateBusinessModelObjectFromCalculatedItem(java.lang.Object bmObject,
                                                    CalculatedItemInterface item)

updateCalculatedItemFromExprValues

boolean updateCalculatedItemFromExprValues(CalculatedItemInterface item,
                                           java.lang.String id,
                                           java.lang.String label,
                                           java.lang.String desc,
                                           int exprType,
                                           java.lang.String text)

updateCalculatedItemFromCalcValues

boolean updateCalculatedItemFromCalcValues(CalculatedItemInterface item,
                                           java.lang.String id,
                                           java.lang.String label,
                                           java.lang.String desc,
                                           int calcType,
                                           java.lang.String text)

getDataSources

java.util.List getDataSources(boolean includeBaseModels)

getBusinessObjectDisplayName

java.lang.String getBusinessObjectDisplayName(java.lang.Object item)

getBusinessObjectTipText

java.lang.String getBusinessObjectTipText(java.lang.Object item)

getBusinessObjectInsertName

java.lang.String getBusinessObjectInsertName(java.lang.Object item)

canBusinessModelObjectHaveChildren

boolean canBusinessModelObjectHaveChildren(java.lang.Object parent)

getBusinessModelObjectChildren

java.util.List getBusinessModelObjectChildren(java.lang.Object parent)

canBusinessModelObjectHaveValues

boolean canBusinessModelObjectHaveValues(java.lang.Object bmObject)

getBusinessModelObjectValues

java.util.List getBusinessModelObjectValues(java.lang.Object bmObject)

getBusinessModelObjectValuesToInsert

java.lang.String getBusinessModelObjectValuesToInsert(java.lang.Object item)

getExpressionTypeNames

java.lang.String[] getExpressionTypeNames()

getExpressionTypeValues

int[] getExpressionTypeValues()

newCalculatedItemFromBusinessObject

CalculatedItemInterface newCalculatedItemFromBusinessObject(java.lang.Object bmObject)

newCalculatedItem

CalculatedItemInterface newCalculatedItem(CalculatedItemInterface toBeCloned)

getImageIconFromIqVisualsBundle

javax.swing.Icon getImageIconFromIqVisualsBundle(java.lang.String imageName)

getBusinessModelObjectImageName

java.lang.String getBusinessModelObjectImageName(java.lang.Object value,
                                                 boolean expanded)

getChildFormats

java.util.List getChildFormats(java.lang.String expressionText,
                               int expressionType,
                               int restrictByType)

validateCalculatedItem

boolean validateCalculatedItem(CalculatedItemInterface item)

validateCalculatedItem

boolean validateCalculatedItem(CalculatedItemInterface item,
                               boolean validateText)

validateItemCalculation

boolean validateItemCalculation(CalculatedItemInterface item)

getLastInvalidExpressionException

java.lang.Exception getLastInvalidExpressionException()

getLastInvalidCalculatedItemMessage

java.lang.String getLastInvalidCalculatedItemMessage()

getResourceScope

com.sas.iquery.metadata.expr.ResourceScope getResourceScope()

setResourceScope

void setResourceScope(com.sas.iquery.metadata.expr.ResourceScope scope)

newExpressionUtilExpression

com.sas.iquery.metadata.expr.ExpressionInterface newExpressionUtilExpression(java.lang.String text,
                                                                             int type)

getExpressionUtilText

java.lang.String getExpressionUtilText(com.sas.iquery.metadata.expr.ExpressionInterface expression)

getFormatFromResources

java.lang.String getFormatFromResources(java.lang.Object dataItem)

getDataItemsAndFolders

java.util.List getDataItemsAndFolders(boolean includeBaseModels)

getBusinessObjectDescription

java.lang.String getBusinessObjectDescription(java.lang.Object item)

canRemoveAllCalculatedItems

boolean canRemoveAllCalculatedItems()