Uses of Interface
com.sas.iquery.metadata.business.DataItem

Packages that use DataItem

com.sas.iquery.builder	Classes in the com.sas.iquery.builder package are used to easily build up complex Intelligent Query objects.
com.sas.iquery.dataservices	Provides utility classes and methods that are used to read information maps and retrieve filter values.
com.sas.iquery.execution2	Provides interfaces and exceptions that are related to SAS Query Services query execution.
com.sas.iquery.metadata.business	The main package that provides modeling for SAS Query Services's two business models (information maps and data selections), which provide a logical layer of metadata modeling above the physical layer model.
com.sas.iquery.metadata.business.step.olap	Provides a set of modeled "step" operations that can be applied, in a particular order, to OLAP data items and business queries in order to filter the data that gets returned when business queries are executed.
com.sas.iquery.metadata.expr	Provides classes that are used to model expressions, which are used to compose data items and filters.
com.sas.iquery.metadata.expr.olap	Provides classes used to define OLAP expressions usable within a business model for defining portions of an OLAP business query.
com.sas.iquery.util	Utility classes that SAS Query Services makes available for use with its models.

Uses of DataItem in com.sas.iquery.builder

Methods in com.sas.iquery.builder that return DataItem

DataItem

DataItemBuilder.build()

Methods in com.sas.iquery.builder that return types with arguments of type DataItem

java.util.Map<DataItem,java.util.Set<TotalingType>>	DisabledTotalsBuilder.build()
static java.util.List<DataItem>	DisabledTotalsBuilder.clearTotaling(BusinessQuery businessQuery, TotalingType totalingType) Clears the totaling lists for the business query.
java.util.Map<DataItem,java.util.Set<TotalingType>>	DisabledTotalsBuilder.getByDataItems() Get a mapping from data selection WITH pending changes that have not been committed with build().
java.util.Map<TotalingType,java.util.Set<DataItem>>	DisabledTotalsBuilder.getByTotalingTypes() Get a mapping from data selection WITH any pending changes that have not been committed with build().
java.util.Set<DataItem>	DisabledTotalsBuilder.getDisabledItemsForType(TotalingType totalingType) Get the data items disabled for the totaling type given WITH any pending changes that have not been committed with build().
static java.util.Map<DataItem,java.util.Set<TotalingType>>	DisabledTotalsBuilder.getDisabledTotalingByItem(BusinessQuery businessQuery) Returns a mapping of data items to the totaling types disabled for that data item.
static java.util.Map<DataItem,java.util.Set<TotalingType>>	DisabledTotalsBuilder.getDisabledTotalingByItem(BusinessQuery businessQuery, boolean recursive) returns a mapping of data items to the totaling types disabled for that data item.
static java.util.Map<TotalingType,java.util.Set<DataItem>>	DisabledTotalsBuilder.getDisabledTotalingByType(BusinessQuery businessQuery) Returns a mapping of data items to the totaling types disabled for that data item.
static java.util.Map<TotalingType,java.util.Set<DataItem>>	DisabledTotalsBuilder.getDisabledTotalingByType(BusinessQuery businessQuery, boolean recursive) Returns a mapping of data items to the totaling types disabled for that data item.
static java.util.List<DataItem>	DisabledTotalsBuilder.removeTotaling(BusinessQuery businessQuery) version of the above remove() that acts directly on the business query
static java.util.List<DataItem>	DisabledTotalsBuilder.removeTotaling(BusinessQuery businessQuery, TotalingType totalingType) Removes the disabled totaling for the totaling type from the business query.

Methods in com.sas.iquery.builder with parameters of type DataItem

DisabledTotalsBuilder	DisabledTotalsBuilder.clear(DataItem... dataItems) Clears all totaling types for the data items given.
static void	DisabledTotalsBuilder.clearTotaling(BusinessQuery businessQuery, TotalingType totalingType, DataItem... dataItems) Clear the data items for the given totaling type.
DisabledTotalsBuilder	DisabledTotalsBuilder.disable(DataItem dataItem, TotalingType... totalingTypes) Disable the item for the totaling types given.
DisabledTotalsBuilder	DisabledTotalsBuilder.disable(TotalingType totalingType, DataItem... dataItems) Disable the totaling type for the items given.
static void	DisabledTotalsBuilder.disableTotaling(BusinessQuery businessQuery, TotalingType totalingType, DataItem... dataItems) Set the data items to have a disabled totaling for the given totaling type.
DisabledTotalsBuilder	DisabledTotalsBuilder.enable(DataItem dataItem, TotalingType... totalingTypes) Enable the item for the totaling types given.
DisabledTotalsBuilder	DisabledTotalsBuilder.enable(TotalingType totalingType, DataItem... dataItems) Enable the totaling type for the items given.
static void	DisabledTotalsBuilder.enableTotaling(BusinessQuery businessQuery, TotalingType totalingType, DataItem... dataItems) Set the data items to have a enabled totaling for the given totaling type.
java.util.Set<TotalingType>	DisabledTotalsBuilder.getDisabledTypesForItem(DataItem dataItem) Get the total types disabled for the data item given WITH any pending changes that have not been committed with build().
static boolean	DisabledTotalsBuilder.isDisabledTotaling(BusinessQuery businessQuery, DataItem item, TotalingType totalingType) Returns true if the total is disabled for that data item or any of the base items for that data item.
static boolean	DisabledTotalsBuilder.isDisabledTotaling(BusinessQuery businessQuery, DataItem item, TotalingType totalingType, boolean checkParentModels, boolean checkRootItems) Returns true if the total is disabled for that data item.
static boolean	DisabledTotalsBuilder.isDisabledTotaling(DataSelection businessQuery, DataItem item, TotalingType totalingType, boolean checkParentModels) Returns true if the total is disabled for that data item or any of the base items for that data item.
static DataItemBuilder	IQBuilderFactory.newDataItemReferenceBuilder(BusinessModel model, DataItem dataItem) returns a builder that will build a DataItemReference

Method parameters in com.sas.iquery.builder with type arguments of type DataItem

static void	DisabledTotalsBuilder.clearByDataItem(BusinessQuery businessQuery, java.util.Map<DataItem,java.util.Set<TotalingType>> mapping) Directly updates the business query with the mapping of data items and to be cleared totaling types.
static void	DisabledTotalsBuilder.disableByDataItem(BusinessQuery businessQuery, java.util.Map<DataItem,java.util.Set<TotalingType>> mapping) Directly updates the business query with the mapping of data items and disabled totaling types.
static void	DisabledTotalsBuilder.enableByDataItem(BusinessQuery businessQuery, java.util.Map<DataItem,java.util.Set<TotalingType>> mapping) Directly updates the business query with the mapping of data items and enabled totaling types.

Uses of DataItem in com.sas.iquery.dataservices

Methods in com.sas.iquery.dataservices with parameters of type DataItem

static java.lang.String	DataRetrievalUtil.generateFormat(DataItem di) Generates a format that will work for the data item based on the data item's expression, aggregation type, and usage.
java.util.List<java.lang.String>	IQDataServices.getAvailableLevels(DataItem dataItem, BusinessQuery businessQuery) Gets the levels that are available for a dataItem based on the business query passed in.
java.util.List<com.sas.storage.olap.TupleElementInterface>	IQDataServices.getMembers(DataItem dataItem) Gets the members for a data item.
java.util.List<com.sas.storage.olap.TupleElementInterface>	IQDataServices.getMembers(DataItem dataItem, int stepNumber) Gets the members for a specific step set on the data item.
java.util.List<com.sas.storage.olap.TupleElementInterface>	IQDataServices.getMembers(DataItem dataItem, int stepNumber, com.sas.storage.olap.MetadataInterface metaI) Gets the members for a specific step set on the data item.
java.util.List<com.sas.storage.olap.TupleElementInterface>	IQDataServices.getMembers(DataItem dataItem, com.sas.storage.olap.MetadataInterface metadataInterface) Gets the members for a specific step set on the data item.
java.util.List<com.sas.storage.olap.TupleElementInterface>	IQDataServices.getMembers(DataItem dataItem, java.lang.String level, com.sas.storage.olap.MetadataInterface metadataInterface, com.sas.storage.olap.TupleElementInterface[] tupleElements) Gets the values for a data item based on the level and the business model passed in.
java.util.List<PossibleFilterValue>	IQDataServices.getPossibleFilterValues(DataItem dataItem) Returns a list of possible values.
java.util.List<PossibleFilterValue>	IQDataServices.getPossibleFilterValues(DataItem dataItem, Governing governing) Returns a list of possible values.
java.util.List<PossibleFilterValue>	IQDataServices.getPossibleFilterValues(DataItem dataItem, Governing governing, boolean honorFilters) Returns a list of possible values.
java.util.List<PossibleFilterValue>	IQDataServices.getPossibleFilterValues(DataItem dataItem, Governing governing, boolean honorFilters, boolean ignoreFormattingForced, int dataToReturn) Returns a list of possible values.
java.util.List<PossibleFilterValue>	IQDataServices.getPossibleFilterValues(DataItem dataItem, Governing governing, boolean honorFilters, boolean ignoreFormattingForced, int dataToReturn, java.lang.StringBuffer sasLog) Returns a list of possible values.
ResultSetInterface	IQDataServices.getResultSet(DataItem dataItem) Gets a result Set for a specific DataItem.
static boolean	DataRetrievalUtil.hasValidROLAPAggregation(DataItem item) Reports whether a data item has an aggregation function which may be used in ROLAP.
static boolean	DataRetrievalUtil.isItemToSummarize(DataItem item) Reports whether a data item should be used in relational totals.
static boolean	DataRetrievalUtil.isNonAdditiveMeasure(DataItem resultItem) Returns true if the item is a non-additive measure
static boolean	DataRetrievalUtil.isSummarizableItem(DataItem item) Reports whether a data item should be used in relational totals.
static boolean	DataRetrievalUtil.isValidROLAPAggregation(DataItem item, Function aggregation) Reports whether a data item can be used with the given aggregation function in ROLAP.

Uses of DataItem in com.sas.iquery.execution2

Methods in com.sas.iquery.execution2 that return DataItem

DataItem	IQResultSetMetaData.getDataItem(java.lang.Object uniquePhysicalObject) Returns the data item associated with this physical object.
DataItem	IQOlapResultSetMetaData.getDataItem(java.lang.Object uniquePhysicalObject)
DataItem	AbstractIQResultSetMetaData.getDataItem(java.lang.Object uniquePhysicalObject)
protected DataItem	AbstractIQResultSetMetaData.stringToDataItem(java.lang.String name)

Methods in com.sas.iquery.execution2 that return types with arguments of type DataItem

java.util.List<DataItem>	IQResultSetMetaData.getDataItems() Returns the list of data items used to create the result set.
java.util.List<DataItem>	AbstractIQResultSetMetaData.getDataItems()

Methods in com.sas.iquery.execution2 with parameters of type DataItem

protected void	AbstractIQResultSetMetaData.addStringToDataItem(java.lang.String string, DataItem dataItem)
java.util.List<DrillPath>	IQResultSetMetaData.getDrillPaths(DataItem di) Return the list of drill paths for this data item.
java.util.List<DrillPath>	IQOlapResultSetMetaData.getDrillPaths(DataItem dataItem) The IQOlapResultSetMetadata implementation of #getDrillPaths(DataItem) returns a list of drill path objects; OLAP result set metadata can be drilled.
java.util.List<DrillPath>	AbstractIQResultSetMetaData.getDrillPaths(DataItem di) The IQResultSetMetaData implementation of #getDrillPaths(DataItem) throws an UnsupportedOperationException.

Uses of DataItem in com.sas.iquery.metadata.business

Subinterfaces of DataItem in com.sas.iquery.metadata.business

interface

DataItemReference Specifies a reference to a DataItem object along with some set of overridden attributes of the base data item.

Methods in com.sas.iquery.metadata.business that return DataItem

DataItem	DataItemReference.getBaseDataItem() Returns the data item that this object is based upon or null if this object is unresolved.
DataItem	SelectedItem.getItem() Returns the data item that is used as a result item.

Methods in com.sas.iquery.metadata.business that return types with arguments of type DataItem

java.util.List<DataItem>	FilterItem.getDataItems(int searchCriteria) Provides a way for consumer to determine what DataItems a given filter may have on it.
java.util.List<DataItem>	BusinessQuery.getEffectiveResultItems() Returns a list of DataItem objects used if this business query were to be run at this time.
java.util.List<DataItem>	BusinessQuery.getEffectiveSortOrderPrecedence() This method returns an ordered list of DataItem objects that, at the time this method returns, would be sorted on if this query were executed.
java.util.List<DataItem>	BusinessQuery.getResultItems() Returns a list of DataItem objects contained in the result item list of this business query.
java.util.List<DataItem>	BusinessQuery.getResultItems(Role withThisRole) Returns a list of DataItem objects contained in the result items that have been assigned the role withThisRole.
java.util.List<DataItem>	BusinessQuery.getSolveOrderPrecedence() Returns an empty list.
java.util.List<DataItem>	BusinessQuery.getSortItems() Deprecated. use #getEffectiveSortOrderPrecedence()
java.util.List<DataItem>	BusinessQuery.getSortOrderPrecedence() This method gets the list of DataItems that was last set via setSortOrderPrecedence which specifies a precedence amongst a set of data items.
java.util.List<DataItem>	BusinessModel.newDataItems(com.sas.iquery.metadata.business.DataSource dataSource) Creates default data items for the specified DataSource to this business model.
java.util.List<DataItem>	BusinessModel.newDataItems(com.sas.iquery.metadata.business.DataSource dataSource, java.util.Properties options) Creates default data items for the specified DataSource to this business model.

Methods in com.sas.iquery.metadata.business with parameters of type DataItem

void	BusinessQuery.addResultItem(DataItem dataItem, Role role) Adds a data item with the specified role to the set of data items contained in this business query that make up the requested results (called the result item list).
ExportColumn	ExportSelectionMetadata.getExportColumn(DataItem underlyingDataItem) Returns a export column for the underlyting data item specified.
ExportColumn	ExportMetadata.getExportColumn(DataItem underlyingDataItem) Returns a export column for the underlyting data item specified.
Role	BusinessQuery.getResultItemRole(DataItem dataItem) Returns the role for the given DataItem contained in the result item list.
ExportColumn	ExportUploadMetadata.getUploadColumn(DataItem underlyingDataItem) Returns an export column for the underlytingDataItem specified, if this data item was not uploaded this call will fail with a metadata exception.
void	BusinessQuery.insertResultItemsAt(DataItem dataItem, Role role, int index) Inserts the specified a data item with the specified role to the set of data items contained in this business query that make up the requested results.
DataItemReference	BusinessModel.newDataItemReference(DataItem baseDataItem) Creates a new DataItemReference object and returns it.
void	BusinessQuery.removeResultItem(DataItem dataItem) Removes the specified data item from the set of result items contained in this object.
void	BusinessQuery.setResultItemRole(DataItem dataItem, Role role) Sets the role for the given data item contained in the result item list.

Method parameters in com.sas.iquery.metadata.business with type arguments of type DataItem

void	BusinessQuery.addResultItems(java.util.List<? extends DataItem> dataItems, Role role) Adds a list of data items with the specified role to the set of data items contained in this business query that make up the requested results (called the result item list).
void	BusinessQuery.removeResultItems(java.util.List<? extends DataItem> dataItems) Removes a list of data items from the list of data items contained in this business query that make up the requested results (called the result item list).
void	BusinessQuery.setResultItems(java.util.List<? extends DataItem> dataItems) Sets the list of data items to use in the result item list.
void	BusinessQuery.setSolveOrderPrecedence(java.util.List<? extends DataItem> solveOrderPrecedence) Throws an UnsupportedOperationException.
void	BusinessQuery.setSortOrderPrecedence(java.util.List<? extends DataItem> sortOrderPrecedence) This method sets the Sort Order Precedence for this query to the set of given data items.

Constructors in com.sas.iquery.metadata.business with parameters of type DataItem

SelectedItem(DataItem item)
Construct a new selected item object with the specified data item.

SelectedItem(DataItem item, Role role)
Construct a new selected item object with the specified data item and role.

SelectedItem(DataItem item, Role role, int formatType)
Construct a new selected item object with the specified data item, role, and format type.

Uses of DataItem in com.sas.iquery.metadata.business.step.olap

Methods in com.sas.iquery.metadata.business.step.olap that return DataItem

DataItem	BusinessQueryTupleFilter.getMeasuresQualifier() Get the measure qualifier (dataItem) that are associated to this filter.
DataItem	TupleFilterMemberQualifier.getMemberItem() Returns the dataItem that is associated to a member value.

Methods in com.sas.iquery.metadata.business.step.olap with parameters of type DataItem

java.lang.String	BaseFilter.getDisplayedText(com.sas.storage.olap.MetadataInterface metadata, DataItem dataItem, boolean showPromptValues, java.util.Locale locale) Return the displayed readable text for this step filter.
java.util.List<com.sas.iquery.metadata.business.QualifiedLevel>	BaseFilter.getLevels(com.sas.storage.olap.MetadataInterface metadata, DataItem dataItem) Get the levels defined for this step.
void	BusinessQueryTupleFilter.setMeasureQualifier(DataItem measureQualifier) Set the measure qualifier (dataItem) that is associated to this filter.
void	TupleFilterMemberQualifier.setMemberItem(DataItem memberItem) Sets the category dataItem that is associated to a member value ([GEOGRAPHIC].

Uses of DataItem in com.sas.iquery.metadata.expr

Methods in com.sas.iquery.metadata.expr that return DataItem

DataItem	FractionOfTotalExpression.getDenominator() Returns the denominator of this fraction expression.
DataItem	FractionOfTotalExpression.getNumerator() Returns the numerator data item used in the computation of the fractional value.

Methods in com.sas.iquery.metadata.expr that return types with arguments of type DataItem

java.util.List<DataItem>	ResourceAwareStringExpression.getLeafDataItems() Return a list of leaf data items (items whose aggType is not "defined in expression")
java.util.List<DataItem>	FunctionCall.getLeafDataItems()
java.util.List<DataItem>	DataItemContainerExpression.getLeafDataItems() Return a list of leaf data items.

Methods in com.sas.iquery.metadata.expr with parameters of type DataItem

void	FractionOfTotalExpression._setDenominator(DataItem denominator)
void	FractionOfTotalExpression._setNumerator(DataItem numerator)
void	FractionOfTotalExpression.setDenominator(DataItem denominator) Sets the denominator of this fraction expression to be the subtotal values for the given category data item.
void	FractionOfTotalExpression.setNumerator(DataItem numerator) Sets the numerator used in the computation of the fractional value to be the specified data item.

Uses of DataItem in com.sas.iquery.metadata.expr.olap

Methods in com.sas.iquery.metadata.expr.olap that return DataItem

DataItem

TimeExpressionMeasure.getMeasure() Returns the name of the measure being used in the calculated member formula.

Methods in com.sas.iquery.metadata.expr.olap with parameters of type DataItem

protected void	MemberFilterExpression.buildMemberTuples(java.util.List<? extends ExpressionInterface> memberNames, DataItem dataItem) IQ internal use only -- do not use.
protected void	BusinessGroupMemberFilterExpression.buildMemberTuples(java.util.List<? extends ExpressionInterface> memberNames, DataItem dataItem) This method is only placeholder for the parent class.
void	TimeExpressionMeasure.setMeasure(DataItem measure) Sets the name of the measure being used in the calculated member formula.
void	MemberFilterExpression.setMemberNames(java.util.List<? extends ExpressionInterface> values, DataItem dataItem) Sets the names of the members to use for filtering where we have applied a DataItem or what is being compared.
void	MemberFilterExpression.setMemberNames(java.util.List<? extends ExpressionInterface> values, DataItem dataItem, java.util.Locale locale) Sets the names of the members to use for filtering where we have applied a DataItem or what is being compared.

Constructors in com.sas.iquery.metadata.expr.olap with parameters of type DataItem

TimeExpressionMeasure(DataItem measure, java.lang.String function)
Create object used to build the MDX expression for creating a time-based calculated measure.

Uses of DataItem in com.sas.iquery.util

Methods in com.sas.iquery.util that return types with arguments of type DataItem

static java.util.List<DataItem>

BusinessQueryOLAPUtil.filterOutRaggedDataItems(java.util.List<DataItem> dataItems) Returns a List of data items that are not based on a ragged-balanced, ragged-unbalanced, or unbalanced hierarchy in an OLAP cube.

Methods in com.sas.iquery.util with parameters of type DataItem

static java.lang.String	BusinessQueryOLAPUtil.buildOLAPExpression(DataItem dataItem, com.sas.storage.olap.MetadataInterface metaI) Build a core MDX expression that contains the definition of simple dimension and measure.
static java.lang.String	BusinessQueryOLAPUtil.generateMeasureHierarchyName(DataItem dataItem)
static java.lang.String	BusinessQueryOLAPUtil.generateUniqueHierarchyName92(DataItem dataItem)
static java.lang.String	BusinessQueryOLAPUtil.getCubeName(BusinessModel businessModel, DataItem dataItem) Get the cube name for an OLAP data item.
static java.lang.String	BusinessQueryOLAPUtil.getDimensionName(BusinessModel businessModel, DataItem dataItem) Get the dimension name for an OLAP data item.
static java.lang.String	BusinessQueryOLAPUtil.getDimensionName(BusinessModel businessModel, DataItem dataItem, com.sas.services.connection.ConnectionInterface connection) IQ internal-use only -- do not call!
static int	BusinessQueryOLAPUtil.getDimensionType(DataItem dataItem, java.lang.Object obj) Get the dimension type for an OLAP data item.
static java.lang.String	BusinessQueryOLAPUtil.getHierarchyName(BusinessModel businessModel, DataItem dataItem) Deprecated. use getHierarchyName(BusinessModel, DataItem, Locale)
static java.lang.String	BusinessQueryOLAPUtil.getHierarchyName(BusinessModel businessModel, DataItem dataItem, java.util.Locale locale)
static java.lang.String	BusinessQueryOLAPUtil.getMeasureName(BusinessModel businessModel, DataItem dataItem) Get the measure name for an OLAP data item.
static com.sas.iquery.metadata.physical.OlapItem	BusinessQueryOLAPUtil.getOlapItem(DataItem dataItem) Get an OlapItem from the dataItem passed in.
static java.lang.String	BusinessQueryOLAPUtil.getUniqueNameWithHierarchyAllMember(DataItem dataItem) Get the unique name with hierarchy all for an OLAP data item.
static boolean	BusinessQueryOLAPUtil.isInMeasureDimension(BusinessModel businessModel, DataItem dataItem) Get the dimension name for an OLAP data item.

Method parameters in com.sas.iquery.util with type arguments of type DataItem

static java.util.List<DataItem>

BusinessQueryOLAPUtil.filterOutRaggedDataItems(java.util.List<DataItem> dataItems) Returns a List of data items that are not based on a ragged-balanced, ragged-unbalanced, or unbalanced hierarchy in an OLAP cube.