oracle.ifs.search
Class SearchClassSpecification

java.lang.Object
  |
  +--oracle.ifs.search.SearchClassSpecification

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class SearchClassSpecification

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

A SearchClassSpecification represents the FROM and SELECT clauses of select statement. In iFS Searches always return objects and not attributes. So the select list is a list of classes and not attributes.

For each Searched class users can specify whether subclass objects should be included in the search. The default behavior is to include subclass objects and to exclude deleted objects.

Users can also specify aliases for the searched classes. This is needed on joins on the same class. If a user specifies an alias for a class, then the alias must be used in place of the class in all the Qualifiers, SortSpecifications, and ResultClass lists. Using the className in place of the alias will cause IfsException-22701 to be thrown.

The aliases must be unique within a SearchClassSpecification. Also the same class cannot be specified more than once without an alias. This will cause IfsException-22700 to be thrown.

 // Usage Examples

 // Here we show combination of default constructor and other mutator
 // methods. Similar results can be achieved using constructor variants,
 // which take additional parameters.
 
 // Simple search class spec with a single class in it.
 // The single class acts as the result class also.
 // Generates Select DOCUMENT.* from DOCUMENT 

 SearchClassSpecification searchClassSpec = new SearchClassSpecification();
 searchClassSpec.addSearchClass(Document.CLASS_NAME);

 // Multiple search classes. Remember to use JoinQualification.
 // Search classes - DOCUMENT, CATEGORY
 // Result Class - DOCUMENT (picked by default)
 // SQL - Select DOCUMENT.* from DOCUMENT, CATEGORY
 SearchClassSpecification searchClassSpec = new SearchClassSpecification();
 searchClassSpec.addSearchClass(Document.CLASS_NAME);
 searchClassSpec.addSearchClass(Category.CLASS_NAME);

 // Overriding the default result class
 searchClassSpec.addResultClass(Category.CLASS_NAME);

 // Using aliases for class names. Aliases very useful when having 
 // same search class more than once in the search class specification.
 // Search Classes - DOCUMENT, CATEGORY
 // Search class aliases - DOC, CAT
 // Result Class - DOCUMENT (Picked by default)
 // SQL - Select DOC.* from DOCUMENT DOC, CATEGORY CAT
 SearchClassSpecification searchClassSpec = new SearchClassSpecification();
 searchClassSpec.addSearchClass(Document.CLASS_NAME, "DOC");
 searchClassSpec.addSearchClass(Category.CLASS_NAME, "CAT");

 // Set up to remove duplicates
 searchClassSpec.setDistinct(true);
 

See Also:

Serialized Form

Constructor Summary

SearchClassSpecification()
Constructs an empty SearchClassSpecification.

SearchClassSpecification(java.lang.String[] sClasses)
Construct SearchClassSpecification, initializing with the set of classes supplied in the parameter.

SearchClassSpecification(java.lang.String[] sClasses, boolean[] delBehavior, boolean[] recBehavior)
Construct SearchClassSpecification, initializing it with the supplied set of classes, delete behavior, and recursive behavior.

SearchClassSpecification(java.lang.String[] sClasses, java.lang.String[] sAliases, boolean[] delBehavior, boolean[] recBehavior)
Construct SearchClassSpecification, initializing it with the set of supplied classes, aliases, delete behavior, and recursive behavior.

Method Summary

void	addResultClass(java.lang.String name) Add name to the ResultClass list.
void	addSearchClass(java.lang.String sClass) Adds the class to the list of Searched Classes.
void	addSearchClass(java.lang.String sClass, java.lang.String sAlias) Adds the class to the list of Searched Classes.
void	addSearchClasses(java.lang.String[] sClasses) Add search classes to list of classes.
void	addSearchClasses(java.lang.String[] sClasses, java.lang.String[] sAliases) add search classes to list of classes.
java.lang.Object	clone() Returns a clone of this SearchClassSpecification.
boolean[]	getRecursiveBehavior() Returns recursive behavior of classes
java.lang.String[]	getResultClassnames() Gets list of result classes
java.lang.String[]	getSearchClassAliases() Gets list of search aliases.
java.lang.String[]	getSearchClassnames() Returns list of search classes
boolean	isDistinct() Get remove duplicates behavior.
void	setDistinct(boolean isDistinct) Set remove duplicates behavior.

Constructor Detail

SearchClassSpecification

public SearchClassSpecification()
                         throws IfsException

Constructs an empty SearchClassSpecification. Class lists are empty.

Throws:

IfsException - if operation fails.

SearchClassSpecification

public SearchClassSpecification(java.lang.String[] sClasses)
                         throws IfsException

Construct SearchClassSpecification, initializing with the set of classes supplied in the parameter. Calls SearchClassSpecification(sClasses, null, null, null)

Parameters:

searchClasses - list of classes to search over.

Throws:

IfsException - if operation fails.

SearchClassSpecification

public SearchClassSpecification(java.lang.String[] sClasses,
                                boolean[] delBehavior,
                                boolean[] recBehavior)
                         throws IfsException

Construct SearchClassSpecification, initializing it with the supplied set of classes, delete behavior, and recursive behavior. Calls SearchClassSpecification(sClasses, null, delBehavior, recBehavior) The length of arrays for delBehavior and recBehavior should be same as that of searchClasses or arrays themselves should be null.

Parameters:

searchClasses - list of classes to search over.

delBehavior - array of boolean describing delete behavior for each class.

recBehavior - array of boolean describing recursive behavior for each class.

Throws:

IfsException - if operation fails.

SearchClassSpecification

public SearchClassSpecification(java.lang.String[] sClasses,
                                java.lang.String[] sAliases,
                                boolean[] delBehavior,
                                boolean[] recBehavior)
                         throws IfsException

Construct SearchClassSpecification, initializing it with the set of supplied classes, aliases, delete behavior, and recursive behavior. Length of aliases, delBehavior and recBehavior arrays should match that of the class array or they should be null.

Parameters:

sClasses - list of classes to search over.

sAliases - Aliases for the classes

delBehavior - array of boolean describing delete behavior for each class.

recBehavior - array of boolean describing recursive behavior for each class.

Throws:

IfsException - if operation fails.

Method Detail

addSearchClasses

public void addSearchClasses(java.lang.String[] sClasses)
                      throws IfsException

Add search classes to list of classes. Calls addSearchClass for each entry in the array.

Parameters:

sClasses - list of classes.

Throws:

IfsException - if the operation fails

addSearchClasses

public void addSearchClasses(java.lang.String[] sClasses,
                             java.lang.String[] sAliases)
                      throws IfsException

add search classes to list of classes. Calls addSearchClass for each entry in the array.

Parameters:

sClasses - list of classes.

sAliases - Aliases for the classes. For unspecified values, alias is assumed to be null.

Throws:

IfsException - if operation fails.

addSearchClass

public void addSearchClass(java.lang.String sClass)
                    throws IfsException

Adds the class to the list of Searched Classes.

Parameters:

sClass - the iFS class being searched

Throws:

IfsException - if operation fails.

addSearchClass

public void addSearchClass(java.lang.String sClass,
                           java.lang.String sAlias)
                    throws IfsException

Adds the class to the list of Searched Classes.

Parameters:

sClass - the iFS class being searched

sAlias - the Alias for the Class, if this is null an internal alias is generated. User must use ClassName in Quals, SortSpec etc.

Throws:

IfsException - 22702 if sClass is null.

getSearchClassnames

public java.lang.String[] getSearchClassnames()

Returns list of search classes

Returns:

list of search classes

getSearchClassAliases

public java.lang.String[] getSearchClassAliases()
                                         throws IfsException

Gets list of search aliases.

Returns:

list of search aliases.

Throws:

IfsException - if the operation fails

getRecursiveBehavior

public boolean[] getRecursiveBehavior()

Returns recursive behavior of classes

Returns:

recursive behavior of classes

addResultClass

public void addResultClass(java.lang.String name)
                    throws IfsException

Add name to the ResultClass list. Name must be a user specified alias or classname.

Parameters:

name - For classes w/o aliases, this should be the className; o.w. this should be the alias.

Throws:

IfsException - 22701 if name is not valid

getResultClassnames

public java.lang.String[] getResultClassnames()
                                       throws IfsException

Gets list of result classes

Returns:

list of result classes

Throws:

IfsException - if the operation fails

clone

public java.lang.Object clone()

Returns a clone of this SearchClassSpecification.

Overrides:

clone in class java.lang.Object

Returns:

Return a clone of this SearchClassSpecification.

setDistinct

public void setDistinct(boolean isDistinct)
                 throws IfsException

Set remove duplicates behavior.

Parameters:

isDistinct - if true, add DISTINCT to select clause.

Throws:

IfsException - if the operation fails

isDistinct

public boolean isDistinct()
                   throws IfsException

Get remove duplicates behavior.

Returns:

true if set, false otherwise.

Throws:

IfsException - if the operation fails