com.cordys.cpc.bsf.busobject

Class QueryObject

java.lang.Object

com.cordys.cpc.bsf.busobject.QueryObject

public class QueryObject
extends java.lang.Object

An instance of class QueryObject is used to execute a query. The current implementation is rather RDBMS/SQL based. QueryObject is integrated with AccessHandler. Each object that is returned from the underlying data store is checked whether the current user has access to read that object. Objects for which access mode is AccessMode.HIDE are removed from the query result.
Note: The methods prefixed with '_' (underscore) must not be used in the application development.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryObject.XqyQueryType Define the query type for the underlying XQY layer

Field Summary

Fields

Modifier and Type	Field and Description
static int	GET
static int	GETLIST
static int	MAP_CUSTOM Used in method setResultMapping.
static int	MAP_EQUAL Used in method setResultMapping.This value defines that the query result is not mapped.
static int	MAP_FLATTEN Used in method setResultMapping.This values defines that the query result must be flattened into single level.
static int	MAP_SPECIFIED Used in method setResultMapping.
static int	PARAM_BIGDECIMAL Used in method addParameter.
static int	PARAM_BOOLEAN Used in method addParameter.
static int	PARAM_BUSOBJECT Used in method addParameter.
static int	PARAM_DATE Used in method addParameter.
static int	PARAM_DOUBLE Used in method addParameter.
static int	PARAM_INT Used in method addParameter.
static int	PARAM_STRING Used in method addParameter.
static int	PARAM_XML Used in method addParameter.

Constructor Summary

Constructors

Constructor and Description
QueryObject(java.lang.String queryText) Construct a QueryObject object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	_getAdditionalInfo(java.lang.String key)
java.lang.String	_getCCFClass()
java.lang.String	_getMapInfo()
int	_getRequestType()
boolean	_isQueryTypeModified()
void	_setCCFClass(java.lang.String ccfClassName)
void	_setMapInfo(java.lang.String ccfMap)
void	_setQueryType(QueryObject.XqyQueryType xqyQueryType)
void	_setRequestType(int operationtype)
void	addAssociationQuery(AssociationQueryObject associationQuery)
void	addParameter(java.lang.String paramName, java.lang.String columnName, int type) Define a parameter for the query.
void	addParameter(java.lang.String paramName, java.lang.String columnName, int type, java.lang.Object value) Define a parameter for the query and set its value.
XqyResultSet	execute() Returns the dataset (resultset) as xml.
XqyResultSet	execute(BusObjectManager busObjectManager) Returns the dataset (resultset) as xml.
boolean	flatSourceEntries()
java.util.Enumeration	getAssociationQueries()
Cursor	getCursor()
int	getMetaData(int metadata)
BusObject	getObject() Returns the BusObject that is the resultant Objects obtained from executing this query.
BusObject	getObject(BusObjectManager bom) Returns the BusObject that is the resultant Objects obtained from executing this query.
<T extends BusObject> BusObjectIterator<T>	getObjects() Returns the BusObjectIterator that contains the resultant Objects obtained from executing this query.
<T extends BusObject> BusObjectIterator<T>	getObjects(BusObjectManager bom) Returns the BusObjectIterator that contains the resultant Objects obtained from executing this query.
java.util.Enumeration	getParameters()
java.lang.String	getQueryText() Returns the query text with which this QueryObject is associated.
QueryObject.XqyQueryType	getQueryType() Deprecated. We are not going to support this api in future releases. Returns the query type set for this QueryObject
java.lang.Class	getResultClass() Returns the class of the resulting objects.
java.lang.String[][]	getResultMapping() Returns the Result Mapping
int	getResultMappingType() Returns the Mapping type.
java.lang.String	getXqyQuery() Returns the query in the xqy format.
void	mapObjectData1(int rootNode, int objectData)
void	setCursor(Cursor cursor) Sets the cursor
void	setParameterValue(java.lang.String paramName, java.lang.Object value) Sets the value of the query parameter of this object.
void	setQueryType(QueryObject.XqyQueryType xqyQueryType) Set the type of query for the underlying XQY layer Note: DBSQL is performance efficient
void	setResultClass(java.lang.Class clazz) To specify the class of resulting objects.
void	setResultMapping(int resultMappingType, java.lang.String[][] strings) Sets the ResultMapping.
void	setTransientResult(boolean asTransient) Specifies whether the objects returned by the query are persistent objects (default) or transient objects.
int	validateQuery(int iValidate)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_STRING

public static final int PARAM_STRING

Used in method addParameter. Used to specify that the parameter is of type String

See Also:

addParameter(String, String, int), Constant Field Values

PARAM_INT

public static final int PARAM_INT

Used in method addParameter. Used to specify that the parameter is of type int

See Also:

addParameter(String, String, int), Constant Field Values

PARAM_DATE

public static final int PARAM_DATE

Used in method addParameter. Used to specify that the parameter is of type Date

See Also:

addParameter(String, String, int), Constant Field Values

PARAM_BIGDECIMAL

public static final int PARAM_BIGDECIMAL

Used in method addParameter. Used to specify that the parameter is of type BigDecimal

See Also:

addParameter(String, String, int), Constant Field Values

PARAM_DOUBLE

public static final int PARAM_DOUBLE

Used in method addParameter. Used to specify that the parameter is of type double

See Also:

addParameter(String, String, int), Constant Field Values

PARAM_BOOLEAN

public static final int PARAM_BOOLEAN

Used in method addParameter. Used to specify that the parameter is of type boolean

See Also:

addParameter(String, String, int), Constant Field Values

PARAM_XML

public static final int PARAM_XML

Used in method addParameter. Used to specify that the parameter is of type xml

See Also:

addParameter(String, String, int), Constant Field Values

PARAM_BUSOBJECT

public static final int PARAM_BUSOBJECT

Used in method addParameter. Used to specify that the parameter is of type BusObject

See Also:

addParameter(String, String, int), Constant Field Values

MAP_EQUAL

public static final int MAP_EQUAL

Used in method setResultMapping.This value defines that the query result is not mapped. This is the default value.

See Also:

setResultMapping(int, String[][]), Constant Field Values

MAP_FLATTEN

public static final int MAP_FLATTEN

Used in method setResultMapping.This values defines that the query result must be flattened into single level.

See Also:

setResultMapping(int, String[][]), Constant Field Values

MAP_SPECIFIED

public static final int MAP_SPECIFIED

Used in method setResultMapping. This values defines that the query result must be mapped according to the specified mapping.

See Also:

setResultMapping(int, String[][]), Constant Field Values

MAP_CUSTOM

public static final int MAP_CUSTOM

Used in method setResultMapping. This values defines that the query result must be mapped according to the tagname of the Custom class specified in the classregistry .

See Also:

setResultMapping(int, String[][]), Constant Field Values

GET

public static final int GET

See Also:

Constant Field Values

GETLIST

public static final int GETLIST

See Also:

Constant Field Values

Constructor Detail

QueryObject

public QueryObject(java.lang.String queryText)

Construct a QueryObject object.

Parameters:

queryText - the query text

Method Detail

setResultClass

public void setResultClass(java.lang.Class clazz)

To specify the class of resulting objects. If no class has been set, the resulting objects are of class generic BusObject.

Parameters:

clazz - the class of the resulting objects.

getResultClass

public java.lang.Class getResultClass()

Returns the class of the resulting objects.

Returns:

setQueryType

public void setQueryType(QueryObject.XqyQueryType xqyQueryType)

Set the type of query for the underlying XQY layer Note: DBSQL is performance efficient

_setQueryType

public void _setQueryType(QueryObject.XqyQueryType xqyQueryType)

getQueryType

@Deprecated
public QueryObject.XqyQueryType getQueryType()

Deprecated. We are not going to support this api in future releases. Returns the query type set for this QueryObject

Returns:

the query type set for this QueryObject

_isQueryTypeModified

public boolean _isQueryTypeModified()

addParameter

public void addParameter(java.lang.String paramName,
                         java.lang.String columnName,
                         int type)

Define a parameter for the query. In the constructor of this object, parameters in the query text are specified as :<parameter>(preceded by ':')

Parameters:

paramName - the name of the parameter; this name should be present in the query text as a parameter (preceded by ':'), e.g. WHERE CustomerID=:CustomerID

columnName - the name of the column the parameter is applied to; it is a concatenation of table name and column name, e.g. "Customer.CustomerID"

type - the type of the column; the value of this field is one of the PARAM_xxx constants in this class.

addParameter

public void addParameter(java.lang.String paramName,
                         java.lang.String columnName,
                         int type,
                         java.lang.Object value)

Define a parameter for the query and set its value.

Parameters:

paramName - the name of the parameter; this name should be present in the query text as a parameter (preceded by ':'), e.g. WHERE CustomerID=:CustomerID

columnName - the name of the column the parameter is applied to; it is a concatenation of table name and column name, e.g. "Customer.CustomerID"

type - the type of the column; the value of this field is one of the PARAM_xxx constants in this class.

value - the value for this parameter

setParameterValue

public void setParameterValue(java.lang.String paramName,
                              java.lang.Object value)

Sets the value of the query parameter of this object. A call of addParameter on this parameter is required before calling setValue on that parameter.

Parameters:

paramName - the name of the parameter;

value - the value for this parameter

See Also:

addParameter(String, String, int)

addAssociationQuery

public void addAssociationQuery(AssociationQueryObject associationQuery)

Parameters:

associationQuery -

getQueryText

public java.lang.String getQueryText()

Returns the query text with which this QueryObject is associated.

Returns:

The Query Text

getAssociationQueries

public java.util.Enumeration getAssociationQueries()

Returns:

Enumeration of AssociationQueryObject objects

setCursor

public void setCursor(Cursor cursor)

Sets the cursor

Parameters:

cursor -

getCursor

public Cursor getCursor()

Returns:

The Cursor object

getParameters

public java.util.Enumeration getParameters()

Returns:

setResultMapping

public void setResultMapping(int resultMappingType,
                             java.lang.String[][] strings)

Sets the ResultMapping. This is used predominantly in the CustomBusObject implementation where the Custom Object attributes have to be "mapped" to the actual persistent StateBusObjects. If Mapping type is specified as MAP_FLATTEN, the framework automatically sets the attributes for the CustomObject in the required order.

For example, if mapping type is MAP_FLATTEN

query.setResultClass(UIOrder.class);
query.setResultMapping(QueryObject.MAP_FLATTEN, null);


For a sample nested derived custom class with an object layout as shown below

                <FullOrderDetails derived="Northwind::OrderDetails">
                    <MyOrderID>OrderID</MyOrderID>
                    <MyProductID>ProductID</MyProductID>
                    <MyUnitPrice>UnitPrice</MyUnitPrice>
                    <MyQuantity>Quantity</MyQuantity>
                    <MyDiscount>Discount</MyDiscount>
                    <MyCategoryID>ProductIDObject.CategoryID</MyCategoryID> -------------------------------> Flattened attributes
                    <MyCategoryName>ProductIDObject.CategoryIDObject.CategoryName</MyCategoryName> --------> Flattened attributes
                    <OrderInfo occ="1" derived="Northwind::Orders" derivedRelation="OrderIDObject"> -------> Nested derived class
                        <OrderID>OrderID</OrderID>
                        <CustomerID>CustomerID</CustomerID>
                        <EmployeeID>EmployeeID</EmployeeID>
                        <OrderDate>OrderDate</OrderDate>
                        <RequiredDate>RequiredDate</RequiredDate>
                        <ShippedDate>ShippedDate</ShippedDate>
                        <ShipVia>ShipVia</ShipVia>
                        <Freight>Freight</Freight>
                        <ShipName>ShipName</ShipName>
                        <ShipAddress>ShipAddress</ShipAddress>
                        <ShipCity>ShipCity</ShipCity>
                        <ShipRegion>ShipRegion</ShipRegion>
                        <ShipPostalCode>ShipPostalCode</ShipPostalCode>
                        <ShipCountry>ShipCountry</ShipCountry>
                        <CustomerName>CustomerIDObject.ContactName</CustomerName> -----> Flattened attributes inside nested derived custom class
                        <EmployeeName>EmployeeIDObject.FirstName</EmployeeName>
                    </OrderInfo>
                </FullOrderDetails>
 

the WSAppServer framework will generate mapping in the Base class as shown below:

        String[][] qMapping = new String[][]{
                 //          SOURCE                  TARGET
                { "FullOrderDetails/Products", "FullOrderDetails/" },
                { "FullOrderDetails/Products/Categories", "FullOrderDetails/" },
                { "FullOrderDetails/Orders", "FullOrderDetails/OrderInfo" },
                { "FullOrderDetails/Orders/Customers", "FullOrderDetails/OrderInfo/" },
                { "FullOrderDetails/Orders/Employees", "FullOrderDetails/OrderInfo/" },
            };
            ....;
        query.setResultMapping(QueryObject.MAP_SPECIFIED, qMapping);
                ....;
 

The objective of the GetXXXObject(s) method is to capture data from the related data fields (from Xqy) and compose a custom bus object. In this case, data fields are coming from Products, Categories, Orders, Customers and Employees models.

Note: Products, Categories, Orders, Customers and Employees are the Standard models (or Persistence models) in 'Northwind' package

Observe that in case of flattened attributes the number of elements in the TARGET mapping before or after the mapping delimiter i.e. / are always less as compared to SOURCE. For above example, it means that WS-AppServer framework will pick the Xqy response from Products and all the children of Products are appended directly to another xml with FullOrderDetails as their root element. Same applies to mappings defined for Customers and Employees

For nested classes, the strategy is to rename the tag to what has been specified in the target mapping i.e. xqy response containing element <Orders> will be renamed to <OrderInfo>

Parameters:

resultMappingType - The mapping type. This could be either MAP_SPECIFIED or MAP_FLATTEN.

strings - pass null if mapping type is MAP_FLATTEN , or a 2-d array specifying the source and target mapping

setTransientResult

public void setTransientResult(boolean asTransient)

Specifies whether the objects returned by the query are persistent objects (default) or transient objects.

Parameters:

asTransient - true to specify that the query result objects are transient, false to result peristent objects

getResultMapping

public java.lang.String[][] getResultMapping()

Returns the Result Mapping

Returns:

a 2-d array of Strings

getResultMappingType

public int getResultMappingType()

Returns the Mapping type. MAP_SPECIFIED, or MAP_FLATTEN

Returns:

getObjects

public <T extends BusObject> BusObjectIterator<T> getObjects()

Returns the BusObjectIterator that contains the resultant Objects obtained from executing this query. If no result class is specified, the BusObjectIterator contains objects of AnonymousBusObject class.

Returns:

BusObjectIterator BusObjectIterator .

getObjects

public <T extends BusObject> BusObjectIterator<T> getObjects(BusObjectManager bom)

Returns the BusObjectIterator that contains the resultant Objects obtained from executing this query. If no result class is specified, the BusObjectIterator contains objects of AnonymousBusObject class.

Parameters:

bom - BusObjectManager

Returns:

BusObjectIterator

getObject

public BusObject getObject()

Returns the BusObject that is the resultant Objects obtained from executing this query. If no result class is specified, objects of AnonymousBusObject class is returned.

Returns:

BusObject

getObject

public BusObject getObject(BusObjectManager bom)

Returns the BusObject that is the resultant Objects obtained from executing this query. If no result class is specified, objects of AnonymousBusObject class is returned.

Parameters:

bom - The associated BusObjectManager object

Returns:

BusObject resultant BusObject

execute

public XqyResultSet execute()

Returns the dataset (resultset) as xml.

Returns:

nom int handle to the dataset node

execute

public XqyResultSet execute(BusObjectManager busObjectManager)

Returns the dataset (resultset) as xml.

Returns:

nom int handle to the dataset node

getXqyQuery

public java.lang.String getXqyQuery()

Returns the query in the xqy format.

Returns:

query in the xqy format.

flatSourceEntries

public boolean flatSourceEntries()

mapObjectData1

public void mapObjectData1(int rootNode,
                           int objectData)

Parameters:

rootNode -

objectData -

validateQuery

public int validateQuery(int iValidate)

getMetaData

public int getMetaData(int metadata)

_setRequestType

public void _setRequestType(int operationtype)

Parameters:

data -

strings -

string -

_getRequestType

public int _getRequestType()

_setCCFClass

public void _setCCFClass(java.lang.String ccfClassName)

_getCCFClass

public java.lang.String _getCCFClass()
                              throws BsfClassRegistryException

Throws:

BsfClassRegistryException

_setMapInfo

public void _setMapInfo(java.lang.String ccfMap)

_getMapInfo

public java.lang.String _getMapInfo()
                             throws BsfClassRegistryException

Throws:

BsfClassRegistryException

_getAdditionalInfo

public java.lang.String _getAdditionalInfo(java.lang.String key)
                                    throws BsfClassRegistryException

Throws:

BsfClassRegistryException