OASelect (OA Java Code Documentation)

java.lang.Object
- com.viaoa.ds.OASelect<TYPE>

All Implemented Interfaces:: Iterable<TYPE>

public class OASelect<TYPE extends OAObject>
extends Object
implements Iterable<TYPE>

Helper Class used for submitting and managing queries for any OADataSource. This is used by Hub.select() methods. All queries are based on object names, property names, and property paths.

A property path is a dot (".") separated list of property names that are used to navigate from a root Class to a property value. To go from object to object, reference property names are used.

An OAFinder can be used to act as the datasource.

An OAFilter can be used to further filter the results.

Queries

All property names and connectors names are case insensitive.
Can use the following connectors "AND", "&&", "||", "OR", "(", ")"
Can use "=", "==", "!=", "<", "<=", ">", ">=", "LIKE", "%" (wildcard), "null" (any case)
use "PASS[" to begin a passthru part of the query, and "]THRU" to end it.
"ASC" ascending, "DESC" descending can be used with Order By properties.

        OASelect select = new OASelect();
        String query = OAConverter.toDataSourceString("dept", dept); // converts to dept.Id = 'MIS'
        String fname = "John";
        query += " && (dept.manager.lastName like 'Jones%'";
        query += " || (dept.manager.firstName == " + OAConvert.toDataSourceString(fname) + ")";
        select.setWhere(query);
        select.setOrder("dept.name, Emp.LastName DESC, emp.firstName");
        select.setPassthru(false);    // needs to be converted to native query language
        select.setCountFirst(false);  // dont need count
        select.setMax(250);           // only select first 250 objects.  (default=0 ALL)
        select.setFetchAmount(40);    // amount of objects to read at a time (default=45)

        // or use params for where query
                query = "dept = ? && dept.manager.lastName like ? || dept.manager.firstname = ?";
                Object[] params = new Object[] {dept, "Jones%", fname};
        select.setWhere(query);
                select.setParams(params);

For more information about this package, see documentation.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`amountCount`
`protected int`	`amountRead`
`protected boolean`	`bAppend`
`protected boolean`	`bCancelled`
`protected boolean`	`bCountFirst`
`protected boolean`	`bHasBeenStarted`
`protected boolean`	`bPassthru`
`protected boolean`	`bRewind`
`protected Class`	`clazz`
`static int`	`defalutFetchAmount`
`protected OAFilter<TYPE>`	`dsFilter`
`protected int`	`fetchAmount`
`protected OAFinder<?,TYPE>`	`finder`
`protected Hub<TYPE>`	`hubSearch`
`protected long`	`lastReadTime`
`protected int`	`max`
`protected OAFilter<TYPE>`	`oaFilter`
`protected String`	`order`
`protected Object[]`	`params`
`protected String`	`propertyFromWhereObject`
`OADataSourceIterator`	`query`
`protected String`	`where`
`protected OAObject`	`whereObject`

Constructor Summary

Constructors
Constructor and Description
`OASelect()` Create a new OASelect that is not initialzed.
`OASelect(Class<TYPE> c)` Create a new OASelect that is initialzed to query Objects for a Class.
`OASelect(Class<TYPE> c, boolean passthru, String where, String order)` Create a new OASelect that is initialzed to query Objects for a Class for a passthru query.
`OASelect(Class<TYPE> c, OAObject whereObject, String order)` Create a new OASelect that is initialzed to query Objects for a Class.
`OASelect(Class<TYPE> c, String where, Object[] params, String order)` Create a new OASelect that is initialized to query Objects for a Class.
`OASelect(Class<TYPE> c, String where, String order)` Create a new OASelect that is initialized to query Objects for a Class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TYPE`	`_next()`
`protected void`	`_select()`
`void`	`add(String whereClause, Object[] params)`
`void`	`cancel()` Cancels and releases query Iterator from OADataSource.
`void`	`close()`
`void`	`execute(String command)` Used to send a "passThru" command to OADataSource.
`protected void`	`finalize()`
`int`	`getAmountRead()` Number of objects loaded so far.
`boolean`	`getAppend()` Flag to show if data should be append to existing collection (used by Hub).
`int`	`getCount()` Returns the amount of records that will be returned from select.
`boolean`	`getCountFirst()` Flag have a count performed before query is executed.
`OADataSource`	`getDataSource()` DataSource that will be used for query/select.
`OAFilter<TYPE>`	`getDataSourceFilter()`
`String`	`getDataSourceQuery()`
`String`	`getDataSourceQuery2()`
`boolean`	`getDirty()`
`int`	`getFetchAmount()` Set the amount of records to read at a time (Default = 45).
`OAFilter<TYPE>`	`getFilter()`
`OAFinder<?,TYPE>`	`getFinder()`
`boolean`	`getHasBeenSelected()`
`OAFilter<TYPE>`	`getHubFilter()`
`int`	`getId()`
`long`	`getLastReadTime()`
`int`	`getMax()` Maximum number of objects to load.
`String`	`getOrder()`
`Object[]`	`getParams()`
`boolean`	`getPassthru()` Flag to show if query should use OADataSource.selectPassthru() instead of OADataSource.select()
`boolean`	`getPassThru()` Flag to show if query should use OADataSource.selectPassthru() instead of OADataSource.select()
`String`	`getPropertyFromWhereObject()` Returns property from Where Object
`boolean`	`getRewind()` Flag to show if data should be rewound to beginning object (used by Hub).
`Hub<TYPE>`	`getSearchHub()`
`Class`	`getSelectClass()` Class of objects that are being selected.
`String`	`getSortBy()`
`String`	`getWhere()` Where clause to use for query.
`Object`	`getWhereObject()` WhereObject is used to build a where statement that will select all objects that have have a reference to whereObject.
`boolean`	`hasBeenStarted()`
`boolean`	`hasMore()` Returns true if more objects are available to be loaded.
`boolean`	`isCancelled()`
`boolean`	`isCounted()` Flag to see if a count has been executed for this query/select.
`boolean`	`isSelectAll()`
`boolean`	`isSelectingNow()`
`Iterator<TYPE>`	`iterator()`
`TYPE`	`next()` Returns next object loaded from select, else null if no other objects are available.
`void`	`reset()` Calls reset(false)
`void`	`reset(boolean bClearOutValues)` Reset so that select can be used again
`void`	`select()` Used to perform select.
`void`	`select(String where)` Used to set where clause, and then perform select.
`void`	`select(String where, Object[] params)` Used to set where clause, and then perform select.
`void`	`select(String where, Object[] params, String order)` Used to set where and order by clauses, and then perform select.
`void`	`select(String where, String order)` Used to set where and order by clauses, and then perform select.
`void`	`setAppend(boolean b)` Flag to show if data should be append to existing collection (used by Hub).
`void`	`setCountFirst(boolean b)` Flag have a count performed before query is executed.
`void`	`setDataSourceFilter(OAFilter<TYPE> hfi)`
`void`	`setDirty(boolean b)`
`void`	`setFetchAmount(int fa)` Set the amount of records to read at a time (Default = 45).
`void`	`setFilter(OAFilter<TYPE> hfi)`
`void`	`setFinder(OAFinder<?,TYPE> finder)`
`void`	`setHasBeenSelected(boolean b)`
`void`	`setHubFilter(OAFilter<TYPE> hfi)`
`void`	`setMax(int x)` Maximum number of objects to load.
`void`	`setOrder(String s)` Sort order clause to use for query.
`void`	`setParams(Object[] params)` Values used to replace '?' in where clause.
`void`	`setPassthru(boolean b)` Flag to show if query should use OADataSource.selectPassthru() instead of OADataSource.select()
`void`	`setPassThru(boolean b)` Flag to show if query should use OADataSource.selectPassthru() instead of OADataSource.select()
`void`	`setPropertyFromWhereObject(String propName)` Property name in whereObject that is used to select objects for this class.
`void`	`setRewind(boolean b)` Flag to show if data should be rewound to beginning object (used by Hub).
`void`	`setSearchHub(Hub<TYPE> hub)`
`void`	`setSelectClass(Class c)` Class of objects that are being selected.
`void`	`setSortBy(String s)`
`void`	`setWhere(String s)`
`void`	`setWhere(String s, Object param)`
`void`	`setWhere(String s, Object[] params)`
`void`	`setWhereObject(OAObject whereObject)` WhereObject is used to build a where statement that will select all objects that have have a reference to whereObject.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - clazz
```
protected Class clazz
```
  - whereObject
```
protected OAObject whereObject
```
  - where
```
protected String where
```
  - order
```
protected String order
```
  - bPassthru
```
protected boolean bPassthru
```
  - bAppend
```
protected boolean bAppend
```
  - bRewind
```
protected boolean bRewind
```
  - propertyFromWhereObject
```
protected String propertyFromWhereObject
```
  - max
```
protected int max
```
  - bCountFirst
```
protected boolean bCountFirst
```
  - amountRead
```
protected int amountRead
```
  - amountCount
```
protected int amountCount
```
  - params
```
protected Object[] params
```
  - query
```
public transient volatile OADataSourceIterator query
```
  - defalutFetchAmount
```
public static final int defalutFetchAmount
```
    See Also:
    
    Constant Field Values
  - fetchAmount
```
protected int fetchAmount
```
  - bCancelled
```
protected boolean bCancelled
```
  - bHasBeenStarted
```
protected boolean bHasBeenStarted
```
  - lastReadTime
```
protected volatile long lastReadTime
```
  - oaFilter
```
protected OAFilter<TYPE extends OAObject> oaFilter
```
  - dsFilter
```
protected OAFilter<TYPE extends OAObject> dsFilter
```
  - finder
```
protected OAFinder<?,TYPE extends OAObject> finder
```
  - hubSearch
```
protected Hub<TYPE extends OAObject> hubSearch
```
- Constructor Detail
  - OASelect
```
public OASelect()
```
    Create a new OASelect that is not initialzed.
  - OASelect
```
public OASelect(Class<TYPE> c)
```
    Create a new OASelect that is initialzed to query Objects for a Class.
  - OASelect
```
public OASelect(Class<TYPE> c,
                boolean passthru,
                String where,
                String order)
```
    Create a new OASelect that is initialzed to query Objects for a Class for a passthru query.
  - OASelect
```
public OASelect(Class<TYPE> c,
                String where,
                String order)
```
    Create a new OASelect that is initialized to query Objects for a Class.
  - OASelect
```
public OASelect(Class<TYPE> c,
                String where,
                Object[] params,
                String order)
```
    Create a new OASelect that is initialized to query Objects for a Class.
  - OASelect
```
public OASelect(Class<TYPE> c,
                OAObject whereObject,
                String order)
```
    Create a new OASelect that is initialzed to query Objects for a Class.
- Method Detail
  - getId
```
public int getId()
```
  - setParams
```
public void setParams(Object[] params)
```
    Values used to replace '?' in where clause.
    
    Parameters:
    
    params - list of values to replace '?' in where clause.
  - getParams
```
public Object[] getParams()
```
  - add
```
public void add(String whereClause,
                Object[] params)
```
  - setSearchHub
```
public void setSearchHub(Hub<TYPE> hub)
```
  - getSearchHub
```
public Hub<TYPE> getSearchHub()
```
  - reset
```
public void reset()
```
    Calls reset(false)
  - reset
```
public void reset(boolean bClearOutValues)
```
    Reset so that select can be used again
    
    Parameters:
    
    bClearOutValues - if true then clears where, order, whereObject
  - setWhereObject
```
public void setWhereObject(OAObject whereObject)
```
    WhereObject is used to build a where statement that will select all objects that have have a reference to whereObject.
    
    See Also:
    
    setPropertyFromWhereObject(java.lang.String)
  - getWhereObject
```
public Object getWhereObject()
```
    WhereObject is used to build a where statement that will select all objects that have have a reference to whereObject.
    
    See Also:
    
    setPropertyFromWhereObject(java.lang.String)
  - setPropertyFromWhereObject
```
public void setPropertyFromWhereObject(String propName)
```
    Property name in whereObject that is used to select objects for this class. This is not required, but should be supplied if the whereObject has more then one path to the select class.
    example: if whereObject is Dept and class is Emp, then "emps"
  - getPropertyFromWhereObject
```
public String getPropertyFromWhereObject()
```
    Returns property from Where Object
    
    See Also:
    
    setPropertyFromWhereObject(java.lang.String)
  - getDataSource
```
public OADataSource getDataSource()
```
    DataSource that will be used for query/select.
  - setSelectClass
```
public void setSelectClass(Class c)
```
    Class of objects that are being selected.
  - getSelectClass
```
public Class getSelectClass()
```
    Class of objects that are being selected.
  - setWhere
```
public void setWhere(String s)
```
  - setWhere
```
public void setWhere(String s,
                     Object[] params)
```
  - setWhere
```
public void setWhere(String s,
                     Object param)
```
  - getWhere
```
public String getWhere()
```
    Where clause to use for query. See notes at beginning of class.
  - setHasBeenSelected
```
public void setHasBeenSelected(boolean b)
```
  - getHasBeenSelected
```
public boolean getHasBeenSelected()
```
  - setHubFilter
```
public void setHubFilter(OAFilter<TYPE> hfi)
```
  - getHubFilter
```
public OAFilter<TYPE> getHubFilter()
```
  - setFilter
```
public void setFilter(OAFilter<TYPE> hfi)
```
  - getFilter
```
public OAFilter<TYPE> getFilter()
```
  - setDataSourceFilter
```
public void setDataSourceFilter(OAFilter<TYPE> hfi)
```
  - getDataSourceFilter
```
public OAFilter<TYPE> getDataSourceFilter()
```
  - setFinder
```
public void setFinder(OAFinder<?,TYPE> finder)
```
    Parameters:
    
    finder -
  - getFinder
```
public OAFinder<?,TYPE> getFinder()
```
  - setOrder
```
public void setOrder(String s)
```
    Sort order clause to use for query. See notes at beginning of class.
  - getOrder
```
public String getOrder()
```
  - setSortBy
```
public void setSortBy(String s)
```
  - getSortBy
```
public String getSortBy()
```
  - setPassThru
```
public void setPassThru(boolean b)
```
    Flag to show if query should use OADataSource.selectPassthru() instead of OADataSource.select()
  - setPassthru
```
public void setPassthru(boolean b)
```
    Flag to show if query should use OADataSource.selectPassthru() instead of OADataSource.select()
  - getPassthru
```
public boolean getPassthru()
```
    Flag to show if query should use OADataSource.selectPassthru() instead of OADataSource.select()
  - getPassThru
```
public boolean getPassThru()
```
    Flag to show if query should use OADataSource.selectPassthru() instead of OADataSource.select()
  - setAppend
```
public void setAppend(boolean b)
```
    Flag to show if data should be append to existing collection (used by Hub).
  - getAppend
```
public boolean getAppend()
```
    Flag to show if data should be append to existing collection (used by Hub).
  - setRewind
```
public void setRewind(boolean b)
```
    Flag to show if data should be rewound to beginning object (used by Hub).
  - getRewind
```
public boolean getRewind()
```
    Flag to show if data should be rewound to beginning object (used by Hub).
  - setCountFirst
```
public void setCountFirst(boolean b)
```
    Flag have a count performed before query is executed.
  - getCountFirst
```
public boolean getCountFirst()
```
    Flag have a count performed before query is executed.
  - setMax
```
public void setMax(int x)
```
    Maximum number of objects to load. Default=0 (read all).
  - getMax
```
public int getMax()
```
    Maximum number of objects to load. Default=0 (read all).
  - getFetchAmount
```
public int getFetchAmount()
```
    Set the amount of records to read at a time (Default = 45).
  - setFetchAmount
```
public void setFetchAmount(int fa)
```
    Set the amount of records to read at a time (Default = 45).
  - getCount
```
public int getCount()
```
    Returns the amount of records that will be returned from select. Calls the OADataSource.count() method.
    
    See Also:
    
    to see if count was already preformed., to have count ran before select is performed
  - isCounted
```
public boolean isCounted()
```
    Flag to see if a count has been executed for this query/select.
  - getAmountRead
```
public int getAmountRead()
```
    Number of objects loaded so far.
    
    See Also:
    
    next()
  - execute
```
public void execute(String command)
```
    Used to send a "passThru" command to OADataSource.
  - select
```
public void select(String where,
                   String order)
```
    Used to set where and order by clauses, and then perform select.
  - select
```
public void select(String where,
                   Object[] params,
                   String order)
```
    Used to set where and order by clauses, and then perform select.
  - select
```
public void select(String where)
```
    Used to set where clause, and then perform select.
  - select
```
public void select(String where,
                   Object[] params)
```
    Used to set where clause, and then perform select.
  - select
```
public void select()
```
    Used to perform select.
  - _select
```
protected void _select()
```
  - isSelectingNow
```
public boolean isSelectingNow()
```
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - getDataSourceQuery
```
public String getDataSourceQuery()
```
  - getDataSourceQuery2
```
public String getDataSourceQuery2()
```
  - next
```
public TYPE next()
```
    Returns next object loaded from select, else null if no other objects are available.
  - _next
```
public TYPE _next()
```
  - isCancelled
```
public boolean isCancelled()
```
  - cancel
```
public void cancel()
```
    Cancels and releases query Iterator from OADataSource.
  - close
```
public void close()
```
  - hasMore
```
public boolean hasMore()
```
    Returns true if more objects are available to be loaded.
  - isSelectAll
```
public boolean isSelectAll()
```
  - hasBeenStarted
```
public boolean hasBeenStarted()
```
  - getLastReadTime
```
public long getLastReadTime()
```
  - iterator
```
public Iterator<TYPE> iterator()
```
    Specified by:
    
    iterator in interface Iterable<TYPE extends OAObject>
  - setDirty
```
public void setDirty(boolean b)
```
  - getDirty
```
public boolean getDirty()
```

Class OASelect<TYPE extends OAObject>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

clazz

whereObject

where

order

bPassthru

bAppend

bRewind

propertyFromWhereObject

max

bCountFirst

amountRead

amountCount

params

query

defalutFetchAmount

fetchAmount

bCancelled

bHasBeenStarted

lastReadTime

oaFilter

dsFilter

finder

hubSearch

Constructor Detail

OASelect

OASelect

OASelect

OASelect

OASelect

OASelect

Method Detail

getId

setParams

getParams

add

setSearchHub

getSearchHub

reset

reset

setWhereObject

getWhereObject

setPropertyFromWhereObject

getPropertyFromWhereObject

getDataSource

setSelectClass

getSelectClass

setWhere

setWhere

setWhere

getWhere

setHasBeenSelected

getHasBeenSelected

setHubFilter

getHubFilter

setFilter

getFilter

setDataSourceFilter

getDataSourceFilter

setFinder

getFinder

setOrder

getOrder

setSortBy

getSortBy

setPassThru

setPassthru

getPassthru

getPassThru

setAppend

getAppend

setRewind

getRewind

setCountFirst