org.net2map.pov.server.Query Class Reference

Inheritance diagram for org.net2map.pov.server.Query:

Inheritance graph
[legend]
Collaboration diagram for org.net2map.pov.server.Query:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class defines a SQL query object.

Query objects are created from DimensionSubset objects by calling of buildQuery inherited method. The normal forme of the query is : SELECT field1,field2 FROM tableA WHERE ... Note that it is possible to use alias to build more complex queries.

Query is decomposed into differents parts (SELECT..., FROM..., WHERE..., ...). The SQL keywords SELECT, FROM, WHERE,... are not included in variables. They contain only literal part of clauses.

At least, the class provides the table name and the field name of the query in a list of DimensionField and DimensionTable objects.

Definition at line 38 of file Query.java.

Public Member Functions

 Query (ParameterSet params)
 Main constructor.

 Query (String name, ParameterSet params)
 Constructor accepting the name of the query.

String getName ()
 Return the query name.

String getSelect ()
 Return current "select" clause.

String getFrom ()
 Return current "from" clause.

String getWhere ()
 Return current "where" clause.

String getGroup ()
 Return current "Group by" clause.

String getHaving ()
 Return current "Having" clause.

String getOrder ()
 Return current "Order by" clause.

void setName (String name)
 Set the name of query.

void setSelect (String select)
 Set the "Select" clause.

void setFrom (String from)
 Set the "From" clause.

void setWhere (String where)
 Set the "Where" clause.

void setGroup (String group)
 Set the "Group by" clause.

void setHaving (String having)
 Set the "Having" clause.

void setOrder (String order)
 Set the "Order by" clause.

String getFieldToJoin ()
 Return field used to join query to another one.

void setFieldToJoin (String field)
 Set field used to join query to another one.

DimensionFieldList getDimensionFields ()
 Return the list of fields objects used in the query.

DimensionTableList getDimensionTables ()
 Return the list of tables used in the query.

String toString ()
 Return concatenation of differents parts of the query.

boolean isEmpty ()
 Test if the query is empty or not.

void joinTo (Query qtoadd)
 Join the query to another one.


Private Attributes

String sName = ""
String sSelect = ""
String sFrom = ""
String sWhere = ""
String sGroup = ""
String sHaving = ""
String sOrder = ""
String sFieldToJoin
DimensionFieldList pDimensionFields = new DimensionFieldList()
DimensionTableList pDimensionTables = new DimensionTableList()
ParameterSet pParameters


Constructor & Destructor Documentation

org.net2map.pov.server.Query.Query ParameterSet  params  ) 
 

Main constructor.

Parameters:
params ParameterSet object

Definition at line 43 of file Query.java.

References org.net2map.pov.server.Query.pParameters.

org.net2map.pov.server.Query.Query String  name,
ParameterSet  params
 

Constructor accepting the name of the query.

Parameters:
params ParameterSet object
name Query name

Definition at line 52 of file Query.java.

References org.net2map.pov.server.Query.pParameters, and org.net2map.pov.server.Query.sName.


Member Function Documentation

DimensionFieldList org.net2map.pov.server.Query.getDimensionFields  ) 
 

Return the list of fields objects used in the query.

Returns:
DimensionFieldList object.

Definition at line 189 of file Query.java.

References org.net2map.pov.server.Query.pDimensionFields.

Referenced by org.net2map.pov.server.DimensionSubsetWord.buildSubset(), org.net2map.pov.server.DimensionSubsetRank.buildSubset(), org.net2map.pov.server.DimensionSubsetExtension.buildSubset(), org.net2map.pov.server.DimensionSubsetDate.buildSubset(), and org.net2map.pov.server.Query.joinTo().

DimensionTableList org.net2map.pov.server.Query.getDimensionTables  ) 
 

Return the list of tables used in the query.

Returns:
DimensionTableList object.

Definition at line 197 of file Query.java.

References org.net2map.pov.server.Query.pDimensionTables.

Referenced by org.net2map.pov.server.DimensionSubsetWord.buildSubset(), org.net2map.pov.server.DimensionSubsetRank.buildSubset(), org.net2map.pov.server.DimensionSubsetExtension.buildSubset(), org.net2map.pov.server.DimensionSubsetDate.buildSubset(), and org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.Query.getFieldToJoin  ) 
 

Return field used to join query to another one.

Returns:
Field name.

Definition at line 173 of file Query.java.

References org.net2map.pov.server.Query.sFieldToJoin.

Referenced by org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.Query.getFrom  ) 
 

Return current "from" clause.

Returns:
From clause.

Definition at line 77 of file Query.java.

References org.net2map.pov.server.Query.sFrom.

Referenced by org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.Query.getGroup  ) 
 

Return current "Group by" clause.

Returns:
Group by clause.

Definition at line 93 of file Query.java.

References org.net2map.pov.server.Query.sGroup.

Referenced by org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.Query.getHaving  ) 
 

Return current "Having" clause.

Returns:
Having clause.

Definition at line 101 of file Query.java.

References org.net2map.pov.server.Query.sHaving.

Referenced by org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.Query.getName  ) 
 

Return the query name.

Returns:
Query name

Definition at line 61 of file Query.java.

References org.net2map.pov.server.Query.sName.

Referenced by org.net2map.pov.server.QueryList.getQuery(), and org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.Query.getOrder  ) 
 

Return current "Order by" clause.

Returns:
Order by clause.

Definition at line 109 of file Query.java.

References org.net2map.pov.server.Query.sOrder.

Referenced by org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.Query.getSelect  ) 
 

Return current "select" clause.

Returns:
Select clause.

Definition at line 69 of file Query.java.

References org.net2map.pov.server.Query.sSelect.

Referenced by org.net2map.pov.server.Query.joinTo().

String org.net2map.pov.server.Query.getWhere  ) 
 

Return current "where" clause.

Returns:
Where clause.

Definition at line 85 of file Query.java.

References org.net2map.pov.server.Query.sWhere.

Referenced by org.net2map.pov.server.Query.joinTo().

boolean org.net2map.pov.server.Query.isEmpty  ) 
 

Test if the query is empty or not.

Returns:
TRUE if query is empty, else FALSE.

Definition at line 220 of file Query.java.

References org.net2map.pov.server.Query.sSelect.

Referenced by org.net2map.pov.server.SearchImpl.buildQueries().

void org.net2map.pov.server.Query.joinTo Query  qtoadd  ) 
 

Join the query to another one.

Parameters:
qtoadd Query object
SELECT clause :

test if the field is key

test if the field name is an alias

FROM clause :

If the table name to link to has the same name then the table name is not added to he clause. Else an error will appear because there will be two relation with the same name. For each table in query to add...

test if the field name is an alias

WHERE clause :

Adding the join equality

GROUP BY clause : Don't forget to add all fields mentioned in select clause (which are not aggregate function).

HAVING clause

ORDER BY clause :

Definition at line 228 of file Query.java.

References org.net2map.pov.server.DimensionFieldList.addDimensionField(), org.net2map.pov.server.DimensionTableList.addDimensionTable(), org.net2map.pov.server.DimensionTableList.count(), org.net2map.pov.server.DimensionFieldList.count(), org.net2map.pov.server.ParameterSet.DEBUG, org.net2map.pov.server.DimensionFieldList.getDimensionField(), org.net2map.pov.server.Query.getDimensionFields(), org.net2map.pov.server.DimensionTableList.getDimensionTable(), org.net2map.pov.server.Query.getDimensionTables(), org.net2map.pov.server.Query.getFieldToJoin(), org.net2map.pov.server.Query.getFrom(), org.net2map.pov.server.Query.getGroup(), org.net2map.pov.server.Query.getHaving(), org.net2map.pov.server.Query.getName(), org.net2map.pov.server.DimensionTable.getName(), org.net2map.pov.server.DimensionField.getName(), org.net2map.pov.server.Query.getOrder(), org.net2map.pov.server.Query.getSelect(), org.net2map.pov.server.DimensionTable.getValue(), org.net2map.pov.server.DimensionField.getValue(), org.net2map.pov.server.Query.getWhere(), org.net2map.pov.server.DimensionField.isKey(), org.net2map.pov.server.DimensionField.mustGroup(), org.net2map.pov.server.Query.pDimensionFields, org.net2map.pov.server.Query.pDimensionTables, org.net2map.pov.server.Query.pParameters, org.net2map.pov.server.Query.sFieldToJoin, org.net2map.pov.server.Query.sFrom, org.net2map.pov.server.Query.sGroup, org.net2map.pov.server.Query.sHaving, org.net2map.pov.server.Query.sOrder, org.net2map.pov.server.Query.sSelect, org.net2map.pov.server.Query.sWhere, and org.net2map.pov.server.Query.toString().

Referenced by org.net2map.pov.server.SearchImpl.buildQueries().

Here is the call graph for this function:

void org.net2map.pov.server.Query.setFieldToJoin String  field  ) 
 

Set field used to join query to another one.

Parameters:
field Field name.

Definition at line 181 of file Query.java.

References org.net2map.pov.server.Query.sFieldToJoin.

Referenced by org.net2map.pov.server.DimensionSubsetWord.buildSubset(), org.net2map.pov.server.DimensionSubsetRank.buildSubset(), org.net2map.pov.server.DimensionSubsetExtension.buildSubset(), and org.net2map.pov.server.DimensionSubsetDate.buildSubset().

void org.net2map.pov.server.Query.setFrom String  from  ) 
 

Set the "From" clause.

Parameters:
from From clause.

Definition at line 133 of file Query.java.

References org.net2map.pov.server.Query.sFrom.

Referenced by org.net2map.pov.server.SearchImpl.buildQueries(), org.net2map.pov.server.DimensionSubsetWord.buildSubset(), org.net2map.pov.server.DimensionSubsetRank.buildSubset(), org.net2map.pov.server.DimensionSubsetExtension.buildSubset(), and org.net2map.pov.server.DimensionSubsetDate.buildSubset().

void org.net2map.pov.server.Query.setGroup String  group  ) 
 

Set the "Group by" clause.

Parameters:
group Group by clause.

Definition at line 149 of file Query.java.

References org.net2map.pov.server.Query.sGroup.

Referenced by org.net2map.pov.server.DimensionSubsetWord.buildSubset().

void org.net2map.pov.server.Query.setHaving String  having  ) 
 

Set the "Having" clause.

Parameters:
having Having clause.

Definition at line 157 of file Query.java.

References org.net2map.pov.server.Query.sHaving.

Referenced by org.net2map.pov.server.DimensionSubsetWord.buildSubset().

void org.net2map.pov.server.Query.setName String  name  ) 
 

Set the name of query.

Parameters:
name Name of query.

Definition at line 117 of file Query.java.

References org.net2map.pov.server.Query.sName.

Referenced by org.net2map.pov.server.SearchImpl.buildQueries().

void org.net2map.pov.server.Query.setOrder String  order  ) 
 

Set the "Order by" clause.

Parameters:
order Order by clause.

Definition at line 165 of file Query.java.

References org.net2map.pov.server.Query.sOrder.

Referenced by org.net2map.pov.server.DimensionSubsetWord.buildSubset().

void org.net2map.pov.server.Query.setSelect String  select  ) 
 

Set the "Select" clause.

Parameters:
select Select clause.

Definition at line 125 of file Query.java.

References org.net2map.pov.server.Query.sSelect.

Referenced by org.net2map.pov.server.SearchImpl.buildQueries(), org.net2map.pov.server.DimensionSubsetWord.buildSubset(), org.net2map.pov.server.DimensionSubsetRank.buildSubset(), org.net2map.pov.server.DimensionSubsetExtension.buildSubset(), and org.net2map.pov.server.DimensionSubsetDate.buildSubset().

void org.net2map.pov.server.Query.setWhere String  where  ) 
 

Set the "Where" clause.

Parameters:
where Where clause.

Definition at line 141 of file Query.java.

References org.net2map.pov.server.Query.sWhere.

Referenced by org.net2map.pov.server.SearchImpl.buildQueries(), org.net2map.pov.server.DimensionSubsetWord.buildSubset(), org.net2map.pov.server.DimensionSubsetRank.buildSubset(), org.net2map.pov.server.DimensionSubsetExtension.buildSubset(), and org.net2map.pov.server.DimensionSubsetDate.buildSubset().

String org.net2map.pov.server.Query.toString  ) 
 

Return concatenation of differents parts of the query.

Note that function add SQL keywords. Use this function to obtain query string to execute.

Returns:
cacatenation of parts of the query.

Definition at line 206 of file Query.java.

References org.net2map.pov.server.Query.sFrom, org.net2map.pov.server.Query.sGroup, org.net2map.pov.server.Query.sHaving, org.net2map.pov.server.Query.sOrder, org.net2map.pov.server.Query.sSelect, and org.net2map.pov.server.Query.sWhere.

Referenced by org.net2map.pov.server.SearchImpl.buildQueries(), org.net2map.pov.server.DimensionSubsetWord.buildSubset(), org.net2map.pov.server.DimensionSubsetRank.buildSubset(), org.net2map.pov.server.DimensionSubsetExtension.buildSubset(), org.net2map.pov.server.DimensionSubsetDate.buildSubset(), org.net2map.pov.server.SearchImpl.execute(), and org.net2map.pov.server.Query.joinTo().


Member Data Documentation

DimensionFieldList org.net2map.pov.server.Query.pDimensionFields = new DimensionFieldList() [private]
 

Definition at line 420 of file Query.java.

Referenced by org.net2map.pov.server.Query.getDimensionFields(), and org.net2map.pov.server.Query.joinTo().

DimensionTableList org.net2map.pov.server.Query.pDimensionTables = new DimensionTableList() [private]
 

Definition at line 421 of file Query.java.

Referenced by org.net2map.pov.server.Query.getDimensionTables(), and org.net2map.pov.server.Query.joinTo().

ParameterSet org.net2map.pov.server.Query.pParameters [private]
 

Definition at line 423 of file Query.java.

Referenced by org.net2map.pov.server.Query.joinTo(), and org.net2map.pov.server.Query.Query().

String org.net2map.pov.server.Query.sFieldToJoin [private]
 

Definition at line 419 of file Query.java.

Referenced by org.net2map.pov.server.Query.getFieldToJoin(), org.net2map.pov.server.Query.joinTo(), and org.net2map.pov.server.Query.setFieldToJoin().

String org.net2map.pov.server.Query.sFrom = "" [private]
 

Definition at line 413 of file Query.java.

Referenced by org.net2map.pov.server.Query.getFrom(), org.net2map.pov.server.Query.joinTo(), org.net2map.pov.server.Query.setFrom(), and org.net2map.pov.server.Query.toString().

String org.net2map.pov.server.Query.sGroup = "" [private]
 

Definition at line 415 of file Query.java.

Referenced by org.net2map.pov.server.Query.getGroup(), org.net2map.pov.server.Query.joinTo(), org.net2map.pov.server.Query.setGroup(), and org.net2map.pov.server.Query.toString().

String org.net2map.pov.server.Query.sHaving = "" [private]
 

Definition at line 416 of file Query.java.

Referenced by org.net2map.pov.server.Query.getHaving(), org.net2map.pov.server.Query.joinTo(), org.net2map.pov.server.Query.setHaving(), and org.net2map.pov.server.Query.toString().

String org.net2map.pov.server.Query.sName = "" [private]
 

Definition at line 411 of file Query.java.

Referenced by org.net2map.pov.server.Query.getName(), org.net2map.pov.server.Query.Query(), and org.net2map.pov.server.Query.setName().

String org.net2map.pov.server.Query.sOrder = "" [private]
 

Definition at line 417 of file Query.java.

Referenced by org.net2map.pov.server.Query.getOrder(), org.net2map.pov.server.Query.joinTo(), org.net2map.pov.server.Query.setOrder(), and org.net2map.pov.server.Query.toString().

String org.net2map.pov.server.Query.sSelect = "" [private]
 

Definition at line 412 of file Query.java.

Referenced by org.net2map.pov.server.Query.getSelect(), org.net2map.pov.server.Query.isEmpty(), org.net2map.pov.server.Query.joinTo(), org.net2map.pov.server.Query.setSelect(), and org.net2map.pov.server.Query.toString().

String org.net2map.pov.server.Query.sWhere = "" [private]
 

Definition at line 414 of file Query.java.

Referenced by org.net2map.pov.server.Query.getWhere(), org.net2map.pov.server.Query.joinTo(), org.net2map.pov.server.Query.setWhere(), and org.net2map.pov.server.Query.toString().


The documentation for this class was generated from the following file:
Accueil | Téléchargement | Manuel | Doc. technique | Sources CVS | Faq | Nous contacter
©2003 - All Rights Reserved