oracle.ifs.search

Class FreeFormQualification

java.lang.Object

oracle.ifs.search.SearchQualification

oracle.ifs.search.FreeFormQualification

All Implemented Interfaces:

Serializable, Cloneable

public class FreeFormQualification
extends SearchQualification

The FreeFormQualification provides a hook for knowledgable & admin users. Users can specify any sql expression, which is integrated into the Search. The provided expression is not parsed in any way, so users must provide the exact sql.

Since the sql generated for searches always uses table aliases, for searches with FreeFormQualifiers you must provide class aliases in the SearchClassSpecification.

In non admin mode the sqlString cannot contain references to unsecure database objects. This is to prevent users from bypassing the security system. But admin users can setup SearchObjects that contain FreeFormQualifiers and give access to normal users to execute them.

Currently FreeFormQualifiers don't support late binding. Hence the sqlString cannot contain '?'.

 //
 // Usage Examples
 //
 //
 // looking for CONTENTOBJECTS which are greater than the average
 // content size
 //
 FreeFormQualification ffq= new FreeFormQualification();
 String sqlExpression = "co.contentsize > " + "(select avg(contentsize) " +
              "from odm_contentobject c, odm_document d where c.id = d.contentobject)");
 ffq.setSqlExpression(sqlExpression);

 

 

Version:

1.0

Author:

Harish Butani

See Also:

Serialized Form

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
String	m_SQLString Specified SQL subClause, that is plugged into the Overall Select Statement.

Fields inherited from class oracle.ifs.search.SearchQualification

LATE_BIND_OPER

Constructor Summary

Constructors

Constructor and Description
FreeFormQualification() Constructs a FreeFormQualification.

Method Summary

Modifier and Type	Method and Description
protected void	accept(oracle.ifs.search.SearchQualificationVisitor v) Accepts a SearchQualificationVisitor.
String	getSQLExpression() Gets the SQL expression of this object.
void	setSqlExpression(String sqlExpression) Sets the SQL expression for this object.

Methods inherited from class oracle.ifs.search.SearchQualification

clone, isLateBound

Methods inherited from class java.lang.Object

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

Field Detail

m_SQLString

public String m_SQLString

Specified SQL subClause, that is plugged into the Overall Select Statement.

(Unpublished)

Constructor Detail

FreeFormQualification

public FreeFormQualification()
                      throws IfsException

Constructs a FreeFormQualification. SQL expression needs to be set before using this object in search.

Throws:

IfsException - if the operation fails

(Published)

Method Detail

setSqlExpression

public void setSqlExpression(String sqlExpression)
                      throws IfsException

Sets the SQL expression for this object.

Parameters:

sqlExpression - SQL expression for this qualification

Throws:

IfsException - if the operation fails

(Published)

getSQLExpression

public String getSQLExpression()
                        throws IfsException

Gets the SQL expression of this object.

Returns:

SQL expression of this object.

Throws:

IfsException - if the operation fails

(Published)

accept

protected void accept(oracle.ifs.search.SearchQualificationVisitor v)
               throws IfsException

Accepts a SearchQualificationVisitor. Calls visitFreeFormQualifier on the visitor. The code in visitFreeFormQualifier is specific to the Visitor.

Specified by:

accept in class SearchQualification

Parameters:

v - SearchQualificationVisitor

Throws:

IfsException - thrown if Visitor code throws.

(Unpublished)