oracle.ifs.server

Class S_PreparedSelector

java.lang.Object

oracle.ifs.server.S_PreparedSelector

Direct Known Subclasses:

S_TiePreparedSelector

public class S_PreparedSelector
extends Object

A S_PreparedSelector class is used to perform a simple search using a cached PreparedStatement, and optionally using bind variables.

Author:

Dave Long

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
S_PreparedSelector(S_LibrarySession session) Constructs a S_PreparedSelector.
S_PreparedSelector(S_LibrarySession session, PreparedSelectorSpecification spec) Constructs a S_PreparedSelector.
S_PreparedSelector(S_LibrarySession session, String key, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, String[] bypassSecAliases, String joinCondition, String searchSelection, SortSpecification sort, boolean recursive, String language, int maxItemCount, int rowNumber, String hint, AttributeValue[] bindValues) Constructs a S_PreparedSelector.
S_PreparedSelector(S_LibrarySession session, String key, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, String searchSelection, SortSpecification sort, boolean recursive, String language, int maxItemCount, int rowNumber, String hint, AttributeValue[] bindValues) Constructs a S_PreparedSelector.
S_PreparedSelector(S_LibrarySession session, String key, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, String joinCondition, String searchSelection, SortSpecification sort, boolean recursive, String language, int maxItemCount, int rowNumber, String hint, AttributeValue[] bindValues) Constructs a S_PreparedSelector.

Method Summary

Modifier and Type	Method and Description
protected void	applySortSpecificationDefaults() Applies the primary search target settings as the default class/alias for the current sort specification.
AttributeValue[]	getAuxiliarySearchTargets() Returns the auxiliary search targets.
AttributeValue[]	getBindValues() Gets the bind values to use in the select statement.
String[]	getBypassSecurityAliases() Returns the bypass security aliases that was set using setBypassSecurityAliases().
static String	getClassFromTarget(AttributeValue target) Deprecated. 9.3.3.0 use PreparedSelector.getClassNameFromTarget
ColumnDescriptor[]	getColumnDescriptors() Gets the column descriptors to use in the select statement.
String	getHint() Gets the SQL hint to use for the main select.
int	getItemCount() Returns the row count of the search.
S_LibraryObject[]	getItems() Returns the entire search results as an array.
String	getJoinCondition() Returns the join condition that was set using setJoinCondition().
int	getMaxItemCount() Returns the maximum number of items that will be returned by getItems.
PreparedSelectorSpecification	getPreparedSelectorSpecification() Returns the PreparedSelectorSpecification that contains the settings.
String	getPrimarySearchAlias() Returns the alias used for the primary search class.
String	getPrimarySearchClass() Returns the search class that was previously set.
AttributeValue	getPrimarySearchTarget() Returns the primary search target.
String	getSearchLanguage() Returns the search language in effect.
AttributeValueTable[]	getSearchResults() Returns the entire search results as an array.
String	getSearchSelection() Returns the search selection that was set using setSearchSelection()
S_LibrarySession	getSession() Returns the session being used by this Selector.
SortSpecification	getSortSpecification() Returns the Sort Specification.
int	getStartingRowNumber() Returns the starting row number.
String	getStatementKey() Returns the statement key.
boolean	isDistinct() Returns true if distinct searching is enabled with respect to classes.
boolean	isRecursiveSearch() Returns true if recursive searching is enabled with respect to classes.
void	setAuxiliarySearchTargets(AttributeValue[] targets) Sets the auxiliary search targets.
void	setBindValues(AttributeValue[] bindValues) Sets the bind values to use in the select statement.
void	setBypassSecurityAliases(String[] bypassSecAliases) Sets the aliases that indicates which PO classes should not have the security clause applied.
void	setColumnDescriptors(ColumnDescriptor[] colDescs) Sets the column descriptors to use in the select statement.
void	setDistinct(boolean distinct) Sets whether to use "distinct" clause.
void	setHint(String hint) Sets the SQL hint to use for the main select.
void	setJoinCondition(String joinCondition) Sets the join condition.
void	setMaxItemCount(int maxItemCount) Sets the maximum number of items that will be returned by getItems.
void	setPrimarySearchClass(String className) Sets the primary search target, specifying the class name only.
void	setPrimarySearchTarget(AttributeValue target) Sets the primary search target.
void	setRecursiveSearch(boolean recursive) Enables/disables recursive searching with respect to classes.
void	setSearchLanguage(String language) Sets the search language.
void	setSearchSelection(String searchSelection) Sets the search selection.
void	setSortSpecification(SortSpecification sort) Sets the Sort Specification.
void	setStartingRowNumber(int rowNumber) Sets the starting row number.
void	setStatementKey(String key) Sets the statement key.

Methods inherited from class java.lang.Object

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

Constructor Detail

S_PreparedSelector

public S_PreparedSelector(S_LibrarySession session,
                          PreparedSelectorSpecification spec)
                   throws IfsException

Constructs a S_PreparedSelector.

Parameters:

session - the current session.

spec - the complete PreparedSelectorSpecification

Throws:

IfsException - if the operation fails

S_PreparedSelector

public S_PreparedSelector(S_LibrarySession session)
                   throws IfsException

Constructs a S_PreparedSelector.

Parameters:

session - the current session.

Throws:

IfsException - if the operation fails

S_PreparedSelector

public S_PreparedSelector(S_LibrarySession session,
                          String key,
                          boolean distinct,
                          AttributeValue searchTarget,
                          AttributeValue[] auxSearchTargets,
                          String searchSelection,
                          SortSpecification sort,
                          boolean recursive,
                          String language,
                          int maxItemCount,
                          int rowNumber,
                          String hint,
                          AttributeValue[] bindValues)
                   throws IfsException

Constructs a S_PreparedSelector.

Parameters:

session - the current session

key - the statement key

distinct - whether to select with "distinct" clause

searchTarget - the primary search target

auxSearchTargets - the auxiliary search targets

searchSelection - the search selection

sort - the sort specification

recursive - whether the search should include subclasses

language - the search language to use

maxItemCount - maximum number of items to select

rowNumber - the starting row number for the returned results

hint - the SQL hint to use for the main select

bindValues - the bind values

Throws:

IfsException - if the operation fails

S_PreparedSelector

public S_PreparedSelector(S_LibrarySession session,
                          String key,
                          boolean distinct,
                          AttributeValue searchTarget,
                          AttributeValue[] auxSearchTargets,
                          String joinCondition,
                          String searchSelection,
                          SortSpecification sort,
                          boolean recursive,
                          String language,
                          int maxItemCount,
                          int rowNumber,
                          String hint,
                          AttributeValue[] bindValues)
                   throws IfsException

Constructs a S_PreparedSelector.

Parameters:

session - the current session

key - the statement key

distinct - whether to select with "distinct" clause

searchTarget - the primary search target

auxSearchTargets - the auxiliary search targets

joinCondition - the join condition

searchSelection - the search selection

sort - the sort specification

recursive - whether the search should include subclasses

language - the search language to use

maxItemCount - maximum number of items to select

rowNumber - the starting row number for the returned results

hint - the SQL hint to use for the main select

bindValues - the bind values

Throws:

IfsException - if the operation fails

S_PreparedSelector

public S_PreparedSelector(S_LibrarySession session,
                          String key,
                          boolean distinct,
                          AttributeValue searchTarget,
                          AttributeValue[] auxSearchTargets,
                          String[] bypassSecAliases,
                          String joinCondition,
                          String searchSelection,
                          SortSpecification sort,
                          boolean recursive,
                          String language,
                          int maxItemCount,
                          int rowNumber,
                          String hint,
                          AttributeValue[] bindValues)
                   throws IfsException

Constructs a S_PreparedSelector.

This is the compelte variant.

Parameters:

session - the current session

key - the statement key

distinct - whether to select with "distinct" clause

searchTarget - the primary search target

auxSearchTargets - the auxiliary search targets

bypassSecAliases - the aliases that indicates bypassing security for POs

joinCondition - the join condition

searchSelection - the search selection

sort - the sort specification

recursive - whether the search should include subclasses

language - the search language to use

maxItemCount - maximum number of items to select

rowNumber - the starting row number for the returned results

hint - the SQL hint to use for the main select

bindValues - the bind values

Throws:

IfsException - if the operation fails

Method Detail

getSession

public S_LibrarySession getSession()
                            throws IfsException

Returns the session being used by this Selector.

Returns:

the current session

Throws:

IfsException - if the operation fails

getPreparedSelectorSpecification

public PreparedSelectorSpecification getPreparedSelectorSpecification()
                                                               throws IfsException

Returns the PreparedSelectorSpecification that contains the settings.

Returns:

the PreparedSelectorSpecification

Throws:

IfsException - if the operation fails

getStatementKey

public String getStatementKey()
                       throws IfsException

Returns the statement key.

Returns:

the statement key

Throws:

IfsException - if the operation fails.

isDistinct

public boolean isDistinct()
                   throws IfsException

Returns true if distinct searching is enabled with respect to classes.

Returns:

true if distinct enabled.

Throws:

IfsException - if the operation fails.

getSortSpecification

public SortSpecification getSortSpecification()
                                       throws IfsException

Returns the Sort Specification.

Returns:

the search item sort specificaion.

Throws:

IfsException - if the operation fails.

getPrimarySearchTarget

public AttributeValue getPrimarySearchTarget()
                                      throws IfsException

Returns the primary search target.

The AttributeValue returned encapulates the class name (as the AttributeValue's name) and the alias (as the AttributeValue's value).

Returns:

the primary search target.

Throws:

IfsException - if operation fails.

getPrimarySearchClass

public String getPrimarySearchClass()
                             throws IfsException

Returns the search class that was previously set.

Returns:

the search class.

Throws:

IfsException - if operation fails.

getPrimarySearchAlias

public String getPrimarySearchAlias()
                             throws IfsException

Returns the alias used for the primary search class.

Returns:

the primary search alias.

Throws:

IfsException - if operation fails.

getAuxiliarySearchTargets

public AttributeValue[] getAuxiliarySearchTargets()
                                           throws IfsException

Returns the auxiliary search targets.

The AttributeValues returned encapulate the class name (as the AttributeValue's name) and the alias (as the AttributeValue's value).

Returns:

the auxiliary search targets.

Throws:

IfsException - if operation fails.

getJoinCondition

public String getJoinCondition()
                        throws IfsException

Returns the join condition that was set using setJoinCondition().

Returns:

the join condition

Throws:

IfsException - if operation fails.

getBypassSecurityAliases

public String[] getBypassSecurityAliases()
                                  throws IfsException

Returns the bypass security aliases that was set using setBypassSecurityAliases().

Returns:

the bypass security aliases

Throws:

IfsException - if operation fails.

getSearchSelection

public String getSearchSelection()
                          throws IfsException

Returns the search selection that was set using setSearchSelection()

Returns:

the search selection.

Throws:

IfsException - if operation fails.

isRecursiveSearch

public boolean isRecursiveSearch()
                          throws IfsException

Returns true if recursive searching is enabled with respect to classes.

Returns:

true is enabled.

Throws:

IfsException - if the operation fails.

getSearchLanguage

public String getSearchLanguage()
                         throws IfsException

Returns the search language in effect.

A value of null indicates that the default language should be used.

Returns:

the search language in effect

Throws:

IfsException - if operation fails.

getMaxItemCount

public int getMaxItemCount()
                    throws IfsException

Returns the maximum number of items that will be returned by getItems.

A value of zero indicates that there is no limit on the desired number of items.

Returns:

maximum number of items that will be returned

Throws:

IfsException - if the operation fails.

getStartingRowNumber

public int getStartingRowNumber()
                         throws IfsException

Returns the starting row number.

The value is 1-based, meaning that if the value is set to 101, the first 100 rows will be skipped. A value of zero or less is treated the same same as a setting of 1, indicating that no rows are skipped.

Returns:

the starting row number

Throws:

IfsException - if the operation fails.

getHint

public String getHint()
               throws IfsException

Gets the SQL hint to use for the main select.

Returns:

the SQL hint

Throws:

IfsException - if the operation fails.

getBindValues

public AttributeValue[] getBindValues()
                               throws IfsException

Gets the bind values to use in the select statement.

Returns:

the bind values

Throws:

IfsException - if the operation fails.

getColumnDescriptors

public ColumnDescriptor[] getColumnDescriptors()
                                        throws IfsException

Gets the column descriptors to use in the select statement.

Returns:

the column descriptors

Throws:

IfsException - if the operation fails.

getClassFromTarget

@Deprecated
public static String getClassFromTarget(AttributeValue target)
                                              throws IfsException

Deprecated. 9.3.3.0 use PreparedSelector.getClassNameFromTarget

Returns the class name from the specified search target.

Parameters:

target - the search target specification.

Returns:

the class name.

Throws:

IfsException - if operation fails.

setStatementKey

public void setStatementKey(String key)
                     throws IfsException

Sets the statement key.

Parameters:

key - the statement key.

Throws:

IfsException - if operation fails.

setDistinct

public void setDistinct(boolean distinct)
                 throws IfsException

Sets whether to use "distinct" clause.

Parameters:

distinct - the distinct indication.

Throws:

IfsException - if operation fails.

setPrimarySearchTarget

public void setPrimarySearchTarget(AttributeValue target)
                            throws IfsException

Sets the primary search target.

Parameters:

target - the search class.

Throws:

IfsException - if operation fails.

setPrimarySearchClass

public void setPrimarySearchClass(String className)
                           throws IfsException

Sets the primary search target, specifying the class name only.

Parameters:

className - the search class.

Throws:

IfsException - if operation fails.

setAuxiliarySearchTargets

public void setAuxiliarySearchTargets(AttributeValue[] targets)
                               throws IfsException

Sets the auxiliary search targets.

Parameters:

targets - the auxiliary search targets.

Throws:

IfsException - if operation fails.

setSortSpecification

public void setSortSpecification(SortSpecification sort)
                          throws IfsException

Sets the Sort Specification.

Parameters:

sort - the sort specificaion.

Throws:

IfsException - if the operation fails.

applySortSpecificationDefaults

protected void applySortSpecificationDefaults()
                                       throws IfsException

Applies the primary search target settings as the default class/alias for the current sort specification.

Throws:

IfsException - if the operation fails.

setJoinCondition

public void setJoinCondition(String joinCondition)
                      throws IfsException

Sets the join condition.

Parameters:

joinCondition - the join condition

Throws:

IfsException - if operation fails.

setBypassSecurityAliases

public void setBypassSecurityAliases(String[] bypassSecAliases)
                              throws IfsException

Sets the aliases that indicates which PO classes should not have the security clause applied.

Parameters:

bypassSecAliases - the bypass security aliases

Throws:

IfsException - if operation fails.

setSearchSelection

public void setSearchSelection(String searchSelection)
                        throws IfsException

Sets the search selection.

Parameters:

searchSelection - the search selection.

Throws:

IfsException - if operation fails.

setRecursiveSearch

public void setRecursiveSearch(boolean recursive)
                        throws IfsException

Enables/disables recursive searching with respect to classes. The default is set true. This is equivalent to adding _R to the class name in extended SQL syntax.

Parameters:

recursive - true for enabled.

Throws:

IfsException - if the operation fails.

setSearchLanguage

public void setSearchLanguage(String language)
                       throws IfsException

Sets the search language.

A value of null indicates that the default language should be used.

Parameters:

language - the search language

Throws:

IfsException - if operation fails.

setMaxItemCount

public void setMaxItemCount(int maxItemCount)
                     throws IfsException

Sets the maximum number of items that will be returned by getItems.

A value of zero indicates that there is no limit on the desired number of items.

Parameters:

maxItemCount - maximum number of items that will be returned

Throws:

IfsException - if the operation fails.

setStartingRowNumber

public void setStartingRowNumber(int rowNumber)
                          throws IfsException

Sets the starting row number.

The value is 1-based, meaning that if the value is set to 101, the first 100 rows will be skipped. A value of zero or less is treated the same same as a setting of 1, indicating that no rows are skipped.

Parameters:

rowNumber - the starting row number

Throws:

IfsException - if the operation fails.

setHint

public void setHint(String hint)
             throws IfsException

Sets the SQL hint to use for the main select.

Parameters:

hint - the SQL hint

Throws:

IfsException - if the operation fails.

setBindValues

public void setBindValues(AttributeValue[] bindValues)
                   throws IfsException

Sets the bind values to use in the select statement.

Parameters:

bindValues - the bind values

Throws:

IfsException - if the operation fails.

setColumnDescriptors

public void setColumnDescriptors(ColumnDescriptor[] colDescs)
                          throws IfsException

Sets the column descriptors to use in the select statement.

Parameters:

colDescs - the column descriptors

Throws:

IfsException - if the operation fails.

getItems

public S_LibraryObject[] getItems()
                           throws IfsException

Returns the entire search results as an array.

Returns:

the search results.

Throws:

IfsException - if operation fails.

getSearchResults

public AttributeValueTable[] getSearchResults()
                                       throws IfsException

Returns the entire search results as an array.

Returns:

the search results.

Throws:

IfsException - if operation fails.

getItemCount

public int getItemCount()
                 throws IfsException

Returns the row count of the search.

Returns:

the search result count.

Throws:

IfsException - if operation fails.