org.mmbase.bridge

Interface NodeQuery

All Superinterfaces:

Cacheable, Cloneable, PublicCloneable<Query>, Query, SearchQuery, SearchQueryWrapper

All Known Implementing Classes:

BasicNodeQuery, NodeQueryWrapper, RemoteNodeQuery_Proxy

public interface NodeQuery
extends Query

A Node-Query is a query that queries node-lists, in contradiction to a normal Query which can query 'cluster nodes' and even more generally 'result nodes' too.

Since:

MMBase-1.7

Version:

$Id$

Author:

Michiel Meeuwissen

Field Summary

Fields inherited from interface org.mmbase.storage.search.SearchQuery

DEFAULT_MAX_NUMBER, DEFAULT_OFFSET

Method Summary

Modifier and Type	Method and Description
List<StepField>	getExtraFields()
NodeManager	getNodeManager() Returns the node-manager.
Step	getNodeStep() Returns the step for which the fields are added (or null)
StepField	getStepField(Field field) Since in a NodeQuery one of the steps is 'exceptional', also this function makes sense now.
Step	setNodeStep(Step step) Removes all fields and add all fields of the given step.

Methods inherited from interface org.mmbase.bridge.Query

addAggregatedField, addField, addField, addNode, addNode, addRelationStep, addRelationStep, addSortOrder, addSortOrder, addSortOrder, addStep, aggregatingClone, clone, cloneWithoutFields, createConstraint, createConstraint, createConstraint, createConstraint, createConstraint, createConstraint, createConstraint, createConstraint, createConstraint, createConstraint, createStepField, createStepField, createStepField, getCleanConstraint, getCloud, getList, getStep, isUsed, markUsed, removeFields, removeImplicitFields, setAlias, setCaseSensitive, setConstraint, setDistinct, setInverse, setMaxNumber, setOffset, toSql

Methods inherited from interface org.mmbase.storage.search.SearchQuery

equals, getConstraint, getFields, getMaxNumber, getOffset, getSortOrders, getSteps, hashCode, isAggregating, isDistinct, toString

Methods inherited from interface org.mmbase.cache.Cacheable

getCachePolicy, setCachePolicy

Methods inherited from interface org.mmbase.storage.search.SearchQueryWrapper

unwrap

Method Detail

getNodeStep

Step getNodeStep()

Returns the step for which the fields are added (or null)

Returns:

step for which the fields are added

setNodeStep

Step setNodeStep(Step step)

Removes all fields and add all fields of the given step. This also can have an effect on the result of getNodeManager().

Parameters:

step - add all fields of the this step

Returns:

the previously associated step (if there was one, otherwise null).

getNodeManager

NodeManager getNodeManager()

Returns the node-manager. Or 'null' if this is not yet determined.

Returns:

node-manager or 'null'

getStepField

StepField getStepField(Field field)

Since in a NodeQuery one of the steps is 'exceptional', also this function makes sense now.

Parameters:

field - field to get the StepField for.

Returns:

null if field is not of 'the' nodemanager.

getExtraFields

List<StepField> getExtraFields()

Since:

MMBase-1.9