com.sssw.fw.api
Interface EbiMetaDataQuery

All Superinterfaces:

EbiQuery, EbiQueryBase, Serializable

All Known Subinterfaces:

EbiDocQuery, EbiUserQuery

public interface EbiMetaDataQuery

extends EbiQuery

Generic interface for defining a SQL query over metadata. When setting up a specific query, you would always instantiate the subinterface appropriate to the element type that you want to search. The subinterfaces provide methods for qualifying the query according to the specific properties of the element type.

For information about full-text search, see EbiQuery.

Field Summary

static int	LDAP_APPROX Ldap operator that corresponds to the '~=' search comparison condition.
static int	LDAP_BETWEEN Ldap operator that corresponds to a SQL 'BETWEEN' operator.
static int	LDAP_ENDS_WITH Ldap operator that corresponds to the '=' search comparison condition where the pattern specifies items that end with a certain sequence of characters.
static int	LDAP_EQUAL Ldap operator that corresponds to the '=' search comparison condition.
static int	LDAP_GEQ Ldap operator that corresponds to the '>=' search comparison condition.
static int	LDAP_GREATER Ldap operator that corresponds to the '!<=' search comparison condition.
static int	LDAP_IN Ldap operator that corresponds to a SQL 'IN' operator.
static int	LDAP_LEQ Ldap operator that corresponds to the '<=' search comparison condition.
static int	LDAP_LESS Ldap operator that corresponds to the '!>=' search comparison condition.
static int	LDAP_MATCH Ldap operator that corresponds to the '=' search comparison condition where the pattern specifies items that contain wildcard characters.
static int	LDAP_PRESENCE Ldap operator that corresponds to the '=*' search comparison condition.
static int	LDAP_STARTS_WITH Ldap operator that corresponds to the '=' search comparison condition where the pattern specifies items that start with a certain sequence of characters.
static int	OP_BETWEEN Operator that corresponds to the SQL 'BETWEEN' operator.
static int	OP_IN Operator that corresponds to the SQL 'IN' operator.
static int	OP_IS_NULL Operator that corresponds to the SQL 'IS NULL' condition.
static int	ROP_EQUAL Relational operator that corresponds to the '=' comparison condition in SQL.
static int	ROP_GEQ Relational operator that corresponds to the '>=' comparison condition in SQL.
static int	ROP_GREATER Relational operator that corresponds to the '>' comparison condition in SQL.
static int	ROP_LEQ Relational operator that corresponds to the '<=' comparison condition in SQL.
static int	ROP_LESS Relational operator that corresponds to the '<' comparison condition in SQL.
static int	SOP_ENDS_WITH String operator that corresponds to the SQL 'LIKE' operator where the pattern specifies items that end with a certain sequence of characters.
static int	SOP_EQUALS_IGNORE_CASE String operator that corresponds to the SQL '=' comparison condition where the case of the operands is ignored.
static int	SOP_LIKE String operator that corresponds to the SQL 'LIKE' operator.
static int	SOP_LIKE_IGNORE_CASE String operator that corresponds to the SQL 'LIKE' operator where case is ignored.
static int	SOP_STARTS_WITH String operator that corresponds to the SQL 'LIKE' operator where the pattern specifies items that start with a certain sequence of characters.

Method Summary

Collection	getSelectedColumnIndices() Gets the selected column indices.
EbiQueryExpression	getWhere() Gets the WHERE clause set on the query.
boolean	isHierarchical() Tests to see if a query should return hierarchical results.
void	setWhere(EbiQueryExpression expr) Sets the WHERE clause into the Query.

Methods implemented from interface com.sssw.fw.api.EbiQuery

allSelected, deselectAll, getOrderBys, getQueryString, getSelects, removeOrderBys, selectAll

Field Detail

ROP_EQUAL

public static final int ROP_EQUAL

Relational operator that corresponds to the '=' comparison condition in SQL.

ROP_LESS

public static final int ROP_LESS

Relational operator that corresponds to the '<' comparison condition in SQL.

ROP_LEQ

public static final int ROP_LEQ

Relational operator that corresponds to the '<=' comparison condition in SQL.

ROP_GREATER

public static final int ROP_GREATER

Relational operator that corresponds to the '>' comparison condition in SQL.

ROP_GEQ

public static final int ROP_GEQ

Relational operator that corresponds to the '>=' comparison condition in SQL.

SOP_LIKE

public static final int SOP_LIKE

String operator that corresponds to the SQL 'LIKE' operator. The right hand side operand (value) may use the SQL wildcard characters such as '%' and '_'. This operator builds an expression like this:

   name LIKE 'a%b_'

SOP_LIKE_IGNORE_CASE

public static final int SOP_LIKE_IGNORE_CASE

String operator that corresponds to the SQL 'LIKE' operator where case is ignored. The right hand side operand (value) may use the SQL wildcard characters such as '%' and '_'. This operator builds an expression like this:

   (LCASE("Customer"."FirstName") LIKE LCASE('Susan'))

SOP_STARTS_WITH

public static final int SOP_STARTS_WITH

String operator that corresponds to the SQL 'LIKE' operator where the pattern specifies items that start with a certain sequence of characters. The right hand side operand (value) may use the SQL wildcard characters such as '%' and '_'. This operator builds an expression like this:

  name LIKE 'foo%'

SOP_ENDS_WITH

public static final int SOP_ENDS_WITH

String operator that corresponds to the SQL 'LIKE' operator where the pattern specifies items that end with a certain sequence of characters. The right hand side operand (value) may use the SQL wildcard characters such as '%' and '_'. This operator builds an expression like this:

  name LIKE '%bar'

SOP_EQUALS_IGNORE_CASE

public static final int SOP_EQUALS_IGNORE_CASE

String operator that corresponds to the SQL '=' comparison condition where the case of the operands is ignored. This operator builds an expression like this:

  (LCASE("Customer"."FirstName") = LCASE('Susan'))

OP_IN

public static final int OP_IN

Operator that corresponds to the SQL 'IN' operator. This operator builds an expression like this:

   Customer.ID IN (1, 2, 3, 4)

OP_BETWEEN

public static final int OP_BETWEEN

Operator that corresponds to the SQL 'BETWEEN' operator. This operator builds an expression like this:

   Customer.ID BETWEEN (1, 4)

OP_IS_NULL

public static final int OP_IS_NULL

Operator that corresponds to the SQL 'IS NULL' condition. This operator builds an expression like this:

   Customer.FIELD1 IS NULL

LDAP_EQUAL

public static final int LDAP_EQUAL

Ldap operator that corresponds to the '=' search comparison condition.

LDAP_LESS

public static final int LDAP_LESS

Ldap operator that corresponds to the '!>=' search comparison condition.

LDAP_LEQ

public static final int LDAP_LEQ

Ldap operator that corresponds to the '<=' search comparison condition.

LDAP_GREATER

public static final int LDAP_GREATER

Ldap operator that corresponds to the '!<=' search comparison condition.

LDAP_GEQ

public static final int LDAP_GEQ

Ldap operator that corresponds to the '>=' search comparison condition.

LDAP_APPROX

public static final int LDAP_APPROX

Ldap operator that corresponds to the '~=' search comparison condition.

LDAP_MATCH

public static final int LDAP_MATCH

Ldap operator that corresponds to the '=' search comparison condition where the pattern specifies items that contain wildcard characters. (e.g., name=f*o).

LDAP_STARTS_WITH

public static final int LDAP_STARTS_WITH

Ldap operator that corresponds to the '=' search comparison condition where the pattern specifies items that start with a certain sequence of characters. (e.g., name=*foo).

LDAP_ENDS_WITH

public static final int LDAP_ENDS_WITH

Ldap operator that corresponds to the '=' search comparison condition where the pattern specifies items that end with a certain sequence of characters. (e.g., name=foo*).

LDAP_IN

public static final int LDAP_IN

Ldap operator that corresponds to a SQL 'IN' operator.

LDAP_BETWEEN

public static final int LDAP_BETWEEN

Ldap operator that corresponds to a SQL 'BETWEEN' operator.

LDAP_PRESENCE

public static final int LDAP_PRESENCE

Ldap operator that corresponds to the '=*' search comparison condition.

Method Detail

getWhere

public EbiQueryExpression getWhere()

Gets the WHERE clause set on the query.

Returns:

An EbiQueryExpression object representing the WHERE clause.

setWhere

public void setWhere(EbiQueryExpression expr)

Sets the WHERE clause into the Query.

Note:Specifying no WHERE clause in the query may drastically worsen the performance of your application. A well-designed WHERE clause reduces the number of rows retrieved to a manageable level.

Parameters:

expr - An EbiQueryExpression object representing the WHERE clause. Pass in null to specify no WHERE clause or to remove a previously set WHERE clause.

getSelectedColumnIndices

public Collection getSelectedColumnIndices()

Gets the selected column indices.

Returns:

A Collection of object arrays. Each object array contains two elements; the first is a string identifying the element type, the second is an Integer identifying the element index.

isHierarchical

public boolean isHierarchical()

Tests to see if a query should return hierarchical results.

Returns:

Boolean true if the query is hierarchical, otherwise false.