All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface ibs.ebf.db.IQuery

public interface IQuery

Method Index

o getComments()
Get query comments.
o getQueryFilePath()
Returns path for the query files where queries are stored.
o getQueryName()
Returns value assigned to 'QUERY_NAME::' in the query file.
o getQueryString()
Returns formatted query string.
o getQueryString(EbfQueryParameters)
Returns formatted query string.
o getRawQuery()
Returns raw query string (unparsed, unformatted).

Methods

o getQueryFilePath 
 public abstract String getQueryFilePath()
Returns path for the query files where queries are stored.

Returns:
File path for the query files.
o getComments 
 public abstract String getComments()
Get query comments. Comments in the query files start with '//'.

Returns:
A string contains comments about the query.
o getQueryName 
 public abstract String getQueryName()
Returns value assigned to 'QUERY_NAME::' in the query file.

Returns:
A string containing value QUERY_NAME:: in the query file.
o getRawQuery 
 public abstract String getRawQuery()
Returns raw query string (unparsed, unformatted). This string is exactly same as what was assigned to 'QUERY::' in the query file.

Returns:
A string containg unparsed, unformatted query string from the query file.
o getQueryString 
 public abstract String getQueryString()
Returns formatted query string. This method takes no arguments and formats the raw query string by replacing query variables (if any) with empty strings.

Returns:
A string containg formatted query string from the query file.
o getQueryString 
 public abstract String getQueryString(EbfQueryParameters QueryParameters)
Returns formatted query string. This method takes an EbfQueryParameters object as an argument and formats the raw query string by replacing query variables(if any) with values from the supplied QueryParameters object.

If for any of the query variables, there was no reference found in the QueryParameters object, that particular query variable is replaced with an empty string( "" ).

Parameters:
QueryParameters - An EbfQueryParameters object containg
Returns:
A string containg formatted query string from the query file. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index