org.mmbase.bridge.util.xml.query

Class QueryDefinition

java.lang.Object

org.mmbase.bridge.util.xml.query.QueryDefinition

Direct Known Subclasses:

MMBaseIndexDefinition

public class QueryDefinition
extends Object

Defines a query and possible options for the fields to index. XXX What's the difference between a Query and a QueryDefinition?

Since:

MMBase-1.8

Version:

$Id$

Author:

Pierre van Rooden

Javadoc:

Field Summary

Fields

Modifier and Type	Field and Description
NodeManager	elementManager The NodeManager of the 'main' nodetype in this query (if appropriate).
Step	elementStep The step in the query describing the 'main' nodetype (if appropriate).
Collection<FieldDefinition>	fields A collection of FieldDefinition objects..
boolean	isMultiLevel If true, the query in this definition returns cluster nodes XXX: how is this different from query instanceof NodeQuery
Query	query The query to run

Constructor Summary

Constructors

Constructor and Description
QueryDefinition()
QueryDefinition(QueryDefinition queryDefinition) Constructor, copies all data from the specified QueryDefinition object.

Method Summary

Modifier and Type	Method and Description
void	configure(Element queryElement) Configures the query definition, using data from a DOM element
Map<String,Object>	getVariables()
void	setVariables(Map<String,Object> vars)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

query

public Query query

The query to run

isMultiLevel

public boolean isMultiLevel

If true, the query in this definition returns cluster nodes XXX: how is this different from query instanceof NodeQuery

elementManager

public NodeManager elementManager

The NodeManager of the 'main' nodetype in this query (if appropriate). XXX: How is this different from NodeQuery#getNodeManager() ?

elementStep

public Step elementStep

The step in the query describing the 'main' nodetype (if appropriate). XXX: How is this different from NodeQuery#getNodeStep() ?

fields

public Collection<FieldDefinition> fields

A collection of FieldDefinition objects..

Constructor Detail

QueryDefinition

public QueryDefinition()

QueryDefinition

public QueryDefinition(QueryDefinition queryDefinition)

Constructor, copies all data from the specified QueryDefinition object.

Method Detail

getVariables

public Map<String,Object> getVariables()

setVariables

public void setVariables(Map<String,Object> vars)

configure

public void configure(Element queryElement)

Configures the query definition, using data from a DOM element

toString

public String toString()

Overrides:

toString in class Object