com.businessobjects.datasource
Class DataSourceSpecification

java.lang.Object
  com.businessobjects.datasource.DataSourceSpecification

All Implemented Interfaces:

java.io.Serializable

public class DataSourceSpecification

extends java.lang.Object

implements java.io.Serializable

The DataSourceSpecification class provides information about the structure and contents of a universe (data source). This class provides access to classes and hierarchies in the universe. To construct a query, first, you must find these objects in the DataSourceSpecification for a universe, and then obtain the keys for these objects. You can then use the keys to include objects in your query.

Example: Obtaining a DataSourceSpecification for a universe.

It is assumed that you have obtained a QueryService instance called boQuerySrv. See QueryService for information about how to obtain a QueryService instance.

 
 // Obtain a list of the universes, or data sources, available in the system.
 DataSource[] boUniverses = boQuerySrv.getDataSourceList();
 // Choose a universe to use for your query and obtain the UID for the universe. For this example, we will choose the first Universe in the list.
 String boUniverseUID = boUniverses[0].getUID();
 // Obtain the DataSourceSpecification for the chosen universe.
 DataSourceSpecification boUniverseSpecification = boQuerySrv.getDataSource(boUniverseUID);
 
 

After you obtain a DataSourceSpecification instance for the universe you want to use to build your query, you need to find all of the QueryResult, QueryCondition, QueryScope, and QuerySort objects in the universe. See DataSourceObject for information about how to find these objects in the universe.

See Also:

DataSourceObject, QuerySpecification, QueryCondition, QueryService, Serialized Form

Constructor Summary

DataSourceSpecification()
Instantiate a new blank DataSourceSpecification object.

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only.
DataSourceClass[]	getDataSourceClass() Gets an array of DataSourceClass instances in the DataSourceSpecification.
DataSourceClass	getDataSourceClass(int i) Gets the DataSourceClass instance located at array index i in the array of DataSourceClass instances contained in this DataSourceSpecification.
java.lang.String	getDescription() Gets the description of this DataSourceSpecification.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
Hierarchy[]	getHierarchy() Gets an array of Hierarchy instances in the DataSourceSpecification.
Hierarchy	getHierarchy(int i) Gets the Hierarchy instance located at array index i in the array of Hierarchy instances contained in this DataSourceSpecification.
int	getMaxInListNumber() Gets the maximum number of values an In-list operator can support.
int	getMaxRetrievalTime() Gets the maximum amount of time (in milliseconds) to wait for retrieving data.
int	getMaxRowsRetrieved() Gets the maximum number of rows that can be retrieved for the data source.
java.lang.String	getName() Gets the name of this DataSourceSpecification.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
static org.apache.axis.description.TypeDesc	getTypeDesc() Internal Use Only.
java.lang.String	getUID() Gets the UID of this DataSourceSpecification.
int	hashCode() Internal Use Only.
boolean	isAdvancedConditionSupported() Returns true if the DataSource object supports Advanced Condition.
boolean	isBothOperatorSupported() Returns true if the DataSource object supports the use of the "Both" operator.
boolean	isCombinedQuerySupported() Returns true if the DataSource object supports combined queries.
boolean	isConditionObjectValueSupported() Returns true if the DataSource supports Object Value Condition.
boolean	isDuplicateRowSupported() Returns true if the DataSource supports duplicate row.
boolean	isExceptOperatorSupported() Returns true if the DataSource object supports the use of the "Except" operator.
boolean	isIsNullOperatorSupported() Returns true if the DataSource object supports is null operator.
boolean	isMissingRowSupported() Returns true if the DataSource supports missing row.
boolean	isNotIsNullOperatorSupported() Returns true if the DataSource object supports is not null operator.
boolean	isRankConditionSupported() Returns true if the DataSource object supports condition ranking.
boolean	isSubQuerySupported() Returns true if the DataSource object supports sub queries.
boolean	isViewSQLSupported() Returns true if the DataSource supports View SQL.
void	setAdvancedConditionSupported(boolean advancedConditionSupported) Internal Use Only.
void	setBothOperatorSupported(boolean bothOperatorSupported) Internal Use Only.
void	setCombinedQuerySupported(boolean combinedQuerySupported) Internal Use Only.
void	setConditionObjectValueSupported(boolean conditionObjectValueSupported) Internal Use Only.
void	setDataSourceClass(DataSourceClass[] dataSourceClass) Internal Use Only.
void	setDataSourceClass(int i, DataSourceClass value) Internal Use Only.
void	setDescription(java.lang.String description) Internal Use Only.
void	setDuplicateRowSupported(boolean duplicateRowSupported) Internal Use Only.
void	setExceptOperatorSupported(boolean exceptOperatorSupported) Internal Use Only.
void	setHierarchy(Hierarchy[] hierarchy) Internal Use Only.
void	setHierarchy(int i, Hierarchy value) Internal Use Only.
void	setIsNullOperatorSupported(boolean isNullOperatorSupported) Internal Use Only.
void	setMaxInListNumber(int maxInListNumber) Internal Use Only.
void	setMaxRetrievalTime(int maxRetrievalTime) Internal Use Only.
void	setMaxRowsRetrieved(int maxRowsRetrieved) Internal Use Only.
void	setMissingRowSupported(boolean missingRowSupported) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNotIsNullOperatorSupported(boolean notIsNullOperatorSupported) Internal Use Only.
void	setRankConditionSupported(boolean rankConditionSupported) Internal Use Only.
void	setSubQuerySupported(boolean subQuerySupported) Internal Use Only.
void	setUID(java.lang.String UID) Internal Use Only.
void	setViewSQLSupported(boolean viewSQLSupported) Internal Use Only.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataSourceSpecification

public DataSourceSpecification()

Instantiate a new blank DataSourceSpecification object.

Method Detail

getDataSourceClass

public DataSourceClass[] getDataSourceClass()

Gets an array of DataSourceClass instances in the DataSourceSpecification. Each DataSourceClass instance contains zero or more DataSourceObject instances.

Returns:

An array of DataSourceClass instances in the DataSourceSpecification

setDataSourceClass

public void setDataSourceClass(DataSourceClass[] dataSourceClass)

Internal Use Only.

getDataSourceClass

public DataSourceClass getDataSourceClass(int i)

Gets the DataSourceClass instance located at array index i in the array of DataSourceClass instances contained in this DataSourceSpecification.

Parameters:

i - the index of the DataSourceClass instance in the array

Returns:

The DataSourceClass instance located at array index i

setDataSourceClass

public void setDataSourceClass(int i,
                               DataSourceClass value)

Internal Use Only.

getHierarchy

public Hierarchy[] getHierarchy()

Gets an array of Hierarchy instances in the DataSourceSpecification. Each Hierarchy instance contains zero or more DataSourceObject instances.

Returns:

An array of Hierarchy instances in the DataSourceSpecification

setHierarchy

public void setHierarchy(Hierarchy[] hierarchy)

Internal Use Only.

getHierarchy

public Hierarchy getHierarchy(int i)

Gets the Hierarchy instance located at array index i in the array of Hierarchy instances contained in this DataSourceSpecification.

Parameters:

i - the index of the Hierarchy instance in the array

Returns:

The Hierarchy instance located at array index i

setHierarchy

public void setHierarchy(int i,
                         Hierarchy value)

Internal Use Only.

getDescription

public java.lang.String getDescription()

Gets the description of this DataSourceSpecification.

Returns:

The description of this DataSourceSpecification

setDescription

public void setDescription(java.lang.String description)

Internal Use Only.

getUID

public java.lang.String getUID()

Gets the UID of this DataSourceSpecification.

Returns:

The UID of this DataSourceSpecification

setUID

public void setUID(java.lang.String UID)

Internal Use Only.

getName

public java.lang.String getName()

Gets the name of this DataSourceSpecification.

Returns:

The name of this DataSourceSpecification

setName

public void setName(java.lang.String name)

Internal Use Only.

getMaxRowsRetrieved

public int getMaxRowsRetrieved()

Gets the maximum number of rows that can be retrieved for the data source.

Returns:

The maximum number of rows that can be retrieved for the data source

setMaxRowsRetrieved

public void setMaxRowsRetrieved(int maxRowsRetrieved)

Internal Use Only.

getMaxRetrievalTime

public int getMaxRetrievalTime()

Gets the maximum amount of time (in milliseconds) to wait for retrieving data.

Returns:

The maximum amount of time, in milliseconds, to wait for data to be retrieved

setMaxRetrievalTime

public void setMaxRetrievalTime(int maxRetrievalTime)

Internal Use Only.

getMaxInListNumber

public int getMaxInListNumber()

Gets the maximum number of values an In-list operator can support. This is defined by the universe designer.

Returns:

The limit of In-list number values that is defined by the universe designer

setMaxInListNumber

public void setMaxInListNumber(int maxInListNumber)

Internal Use Only.

isRankConditionSupported

public boolean isRankConditionSupported()

Returns true if the DataSource object supports condition ranking.

Returns:

"true", if the DataSource object supports condition ranking, otherwise false

setRankConditionSupported

public void setRankConditionSupported(boolean rankConditionSupported)

Internal Use Only.

isSubQuerySupported

public boolean isSubQuerySupported()

Returns true if the DataSource object supports sub queries.

Returns:

"true", if the DataSource object supports sub queries, otherwise false

setSubQuerySupported

public void setSubQuerySupported(boolean subQuerySupported)

Internal Use Only.

isCombinedQuerySupported

public boolean isCombinedQuerySupported()

Returns true if the DataSource object supports combined queries.

Returns:

"true", if the DataSource object supports combined queries, otherwise false

setCombinedQuerySupported

public void setCombinedQuerySupported(boolean combinedQuerySupported)

Internal Use Only.

isBothOperatorSupported

public boolean isBothOperatorSupported()

Returns true if the DataSource object supports the use of the "Both" operator.

Returns:

"true", if the DataSource object supports the use of the "Both" operator, otherwise false

setBothOperatorSupported

public void setBothOperatorSupported(boolean bothOperatorSupported)

Internal Use Only.

isExceptOperatorSupported

public boolean isExceptOperatorSupported()

Returns true if the DataSource object supports the use of the "Except" operator.

Returns:

"true", if the DataSource object supports the use of the "Except" operator, otherwise false

setExceptOperatorSupported

public void setExceptOperatorSupported(boolean exceptOperatorSupported)

Internal Use Only.

isAdvancedConditionSupported

public boolean isAdvancedConditionSupported()

Returns true if the DataSource object supports Advanced Condition.

Returns:

true if the DataSource object supports Advanced Condition, otherwise false

setAdvancedConditionSupported

public void setAdvancedConditionSupported(boolean advancedConditionSupported)

Internal Use Only.

isConditionObjectValueSupported

public boolean isConditionObjectValueSupported()

Returns true if the DataSource supports Object Value Condition.

Returns:

true if the DataSource supports Object Value Condition, otherwise false

setConditionObjectValueSupported

public void setConditionObjectValueSupported(boolean conditionObjectValueSupported)

Internal Use Only.

isDuplicateRowSupported

public boolean isDuplicateRowSupported()

Returns true if the DataSource supports duplicate row.

Returns:

true if the DataSource supports duplicate row, otherwise false

setDuplicateRowSupported

public void setDuplicateRowSupported(boolean duplicateRowSupported)

Internal Use Only.

isIsNullOperatorSupported

public boolean isIsNullOperatorSupported()

Returns true if the DataSource object supports is null operator.

Returns:

true if the DataSource supports is null operator, otherwise false

setIsNullOperatorSupported

public void setIsNullOperatorSupported(boolean isNullOperatorSupported)

Internal Use Only.

isNotIsNullOperatorSupported

public boolean isNotIsNullOperatorSupported()

Returns true if the DataSource object supports is not null operator.

Returns:

true if the DataSource supports is not null operator, otherwise false

setNotIsNullOperatorSupported

public void setNotIsNullOperatorSupported(boolean notIsNullOperatorSupported)

Internal Use Only.

isViewSQLSupported

public boolean isViewSQLSupported()

Returns true if the DataSource supports View SQL.

Returns:

true if the DataSource supports View SQL, otherwise false

setViewSQLSupported

public void setViewSQLSupported(boolean viewSQLSupported)

Internal Use Only.

isMissingRowSupported

public boolean isMissingRowSupported()

Returns true if the DataSource supports missing row.

Returns:

true if the DataSource supports missing row, otherwise false

setMissingRowSupported

public void setMissingRowSupported(boolean missingRowSupported)

Internal Use Only.

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

hashCode

public int hashCode()

Internal Use Only.

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Internal Use Only.

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Internal Use Only.

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Internal Use Only.