org.mmbase.bridge.remote.proxy

Class RemoteNodeQuery_Proxy

java.lang.Object

org.mmbase.bridge.remote.proxy.MappedObject_Proxy<RemoteNodeQuery>

org.mmbase.bridge.remote.proxy.RemoteNodeQuery_Proxy

All Implemented Interfaces:

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

public class RemoteNodeQuery_Proxy
extends MappedObject_Proxy<RemoteNodeQuery>
implements NodeQuery

RemoteNodeQuery_Proxy in a generated smart proxy of NodeQuery
This smart proxy is used by a local class when the MMCI is called remotely

Author:

generated by org.mmbase.mojo.remote.ProxyGenerator

Field Summary

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

DEFAULT_MAX_NUMBER, DEFAULT_OFFSET

Constructor Summary

Constructors

Constructor and Description
RemoteNodeQuery_Proxy(RemoteNodeQuery remoteObject)

Method Summary

Modifier and Type	Method and Description
AggregatedField	addAggregatedField(Step arg0, Field arg1, int arg2) Add an aggregated field to a step
StepField	addField(Step arg0, Field arg1) Adds a field to a step.
StepField	addField(String arg0) Adds a field by string
void	addNode(Step arg0, int arg1)
void	addNode(Step arg0, Node arg1) Adds a node to a step.
RelationStep	addRelationStep(NodeManager arg0) If you need to add a 'related' NodeManager without specifying a role/searchDir simply use these addRelationStep.
RelationStep	addRelationStep(NodeManager arg0, String arg1, String arg2) Adds new Relation step to the query.
SortOrder	addSortOrder(StepField arg0, int arg1) Defaulting version of Query.addSortOrder(StepField, int, boolean, int) (sorting case insensitively, and no date parts).
SortOrder	addSortOrder(StepField arg0, int arg1, boolean arg2) Defaulting version of Query.addSortOrder(StepField, int, boolean, int) (no date parts)
SortOrder	addSortOrder(StepField arg0, int arg1, boolean arg2, int arg3) Adds an order on a certain field.
Step	addStep(NodeManager arg0) Adds a NodeManager to this Query.
Query	aggregatingClone() Creates an unused aggregate clone of this query.
Query	clone() Create an (unused) clone
Query	cloneWithoutFields() Clones this object, only without the fields
CompositeConstraint	createConstraint(Constraint arg0, int arg1, Constraint arg2) Combines two Constraints to one new one, using a boolean operator (AND or OR).
FieldNullConstraint	createConstraint(StepField arg0) Create a constraint (for use with this Query object).
FieldValueConstraint	createConstraint(StepField arg0, int arg1, Object arg2) Create a constraint (for use with this Query object).
FieldValueConstraint	createConstraint(StepField arg0, int arg1, Object arg2, int arg3) Create a constraint (for use with this Query object).
CompareFieldsConstraint	createConstraint(StepField arg0, int arg1, StepField arg2) Create a constraint (for use with this Query object).
FieldValueConstraint	createConstraint(StepField arg0, Object arg1) Create a constraint (for use with this Query object).
FieldValueBetweenConstraint	createConstraint(StepField arg0, Object arg1, Object arg2) Create a constraint (for use with this Query object).
FieldValueInQueryConstraint	createConstraint(StepField arg0, Query arg1)
FieldValueInConstraint	createConstraint(StepField arg0, SortedSet<?> arg1) Create a constraint (for use with this Query object).
LegacyConstraint	createConstraint(String arg0) Create a constraint (for use with this Query object).
StepField	createStepField(Step arg0, Field arg1) Creates a StepField object withouth adding it (needed for aggregated queries).
StepField	createStepField(Step arg0, String arg1) Creates a StepField object withouth adding it (needed for aggregated queries).
StepField	createStepField(String arg0) Creates the step field for the given name.
CachePolicy	getCachePolicy() Returns the CachePolicy of the object.
Constraint	getCleanConstraint() Gets the 'clean' constraint on this query.
Cloud	getCloud() Returns the Cloud for which this Query was defined.
Constraint	getConstraint() Gets the constraints on the search results.
List<StepField>	getExtraFields()
List<StepField>	getFields() Gets the stepfields in the search request.
NodeList	getList() Executes the query and returns the resulting node list.
int	getMaxNumber() Gets the maximum number of results to be returned, or -1 if the number of results to be returned is unlimited.
NodeManager	getNodeManager() Returns the node-manager.
Step	getNodeStep() Returns the step for which the fields are added (or null)
int	getOffset() Gets the (zerobased) offset in the list of results, of the first result to return.
List<SortOrder>	getSortOrders() Gets the SortOrder objects in the order they are to be applied.
Step	getStep(String arg0) Returns the step with given alias, or null if it is not present
StepField	getStepField(Field arg0) Since in a NodeQuery one of the steps is 'exceptional', also this function makes sense now.
List<Step>	getSteps() Gets the steps in the search request.
RemoteNodeQuery	getWrappedObject()
boolean	isAggregating() Tests if this is an aggregating query, i.e.
boolean	isDistinct() Tests if the search request is to return distinct results.
boolean	isUsed() Whether this query was used or not.
boolean	markUsed() Mark this query 'used'.
void	removeFields() Removes all fields from the Query object.
void	removeImplicitFields()
void	setAlias(Step arg0, String arg1) Sets the alias to the given step.
void	setCachePolicy(CachePolicy arg0) Sets the CachePolicy of the query.
FieldConstraint	setCaseSensitive(FieldConstraint arg0, boolean arg1) Changes the given constraint's 'case sensitivity' (if applicable).
void	setConstraint(Constraint arg0) The (composite) constraint can actually be set into the query with this method.
Query	setDistinct(boolean arg0) Specifies wether the query result must contain only 'distinct' results.
Constraint	setInverse(Constraint arg0, boolean arg1) Changes the given constraint's 'inverse' (if applicable).
Query	setMaxNumber(int arg0) Limits the query-result to maxNumber records.
Step	setNodeStep(Step arg0) Removes all fields and add all fields of the given step.
Query	setOffset(int arg0) Offsets the query-result with offset records.
String	toSql() Shows the query in a human-readable SQL form.
SearchQuery	unwrap()

Methods inherited from class org.mmbase.bridge.remote.proxy.MappedObject_Proxy

equals, getMapperCode, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

equals, hashCode, toString

Constructor Detail

RemoteNodeQuery_Proxy

public RemoteNodeQuery_Proxy(RemoteNodeQuery remoteObject)

Method Detail

getNodeManager

public NodeManager getNodeManager()

Description copied from interface: NodeQuery

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

Specified by:

getNodeManager in interface NodeQuery

Returns:

node-manager or 'null'

getNodeStep

public Step getNodeStep()

Description copied from interface: NodeQuery

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

Specified by:

getNodeStep in interface NodeQuery

Returns:

step for which the fields are added

setNodeStep

public Step setNodeStep(Step arg0)

Description copied from interface: NodeQuery

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

Specified by:

setNodeStep in interface NodeQuery

Parameters:

arg0 - add all fields of the this step

Returns:

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

getStepField

public StepField getStepField(Field arg0)

Description copied from interface: NodeQuery

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

Specified by:

getStepField in interface NodeQuery

Parameters:

arg0 - field to get the StepField for.

Returns:

null if field is not of 'the' nodemanager.

getExtraFields

public List<StepField> getExtraFields()

Specified by:

getExtraFields in interface NodeQuery

addRelationStep

public RelationStep addRelationStep(NodeManager arg0)

Description copied from interface: Query

If you need to add a 'related' NodeManager without specifying a role/searchDir simply use these addRelationStep.

Specified by:

addRelationStep in interface Query

Parameters:

arg0 - node manager on the other side of the relation

Returns:

new Relation step

addRelationStep

public RelationStep addRelationStep(NodeManager arg0,
                                    String arg1,
                                    String arg2)

Description copied from interface: Query

Adds new Relation step to the query. Adds the next step as well, it can be retrieved by calling getNext() on the relationstep, and cast to Step.

Specified by:

addRelationStep in interface Query

Parameters:

arg0 - node manager on the other side of the relation

arg1 - role of a relation

arg2 - the direction of the relation

Returns:

new Relation step

removeFields

public void removeFields()

Description copied from interface: Query

Removes all fields from the Query object.

Specified by:

removeFields in interface Query

createStepField

public StepField createStepField(Step arg0,
                                 String arg1)

Description copied from interface: Query

Creates a StepField object withouth adding it (needed for aggregated queries).

Specified by:

createStepField in interface Query

Parameters:

arg0 - step to create StepField from

arg1 - name of field to create StepField from

Returns:

new StepField

createStepField

public StepField createStepField(String arg0)

Description copied from interface: Query

Creates the step field for the given name. For a NodeQuery the arguments is simply the name of the field. For a 'normal' query, it should be prefixed by the (automatic) alias of the Step.

Specified by:

createStepField in interface Query

Parameters:

arg0 - field identifier to create StepField from

Returns:

new StepField

createStepField

public StepField createStepField(Step arg0,
                                 Field arg1)

Description copied from interface: Query

Creates a StepField object withouth adding it (needed for aggregated queries).

Specified by:

createStepField in interface Query

Parameters:

arg0 - step to create StepField from

arg1 - field to create StepField from

Returns:

new StepField

addAggregatedField

public AggregatedField addAggregatedField(Step arg0,
                                          Field arg1,
                                          int arg2)

Description copied from interface: Query

Add an aggregated field to a step

Specified by:

addAggregatedField in interface Query

Parameters:

arg0 - step to add field to

arg1 - field to add

arg2 - Type of aggregation

Returns:

new AggregatedField

setDistinct

public Query setDistinct(boolean arg0)

Description copied from interface: Query

Specifies wether the query result must contain only 'distinct' results.

Specified by:

setDistinct in interface Query

Parameters:

arg0 - 'distinct' results

Returns:

Query

See Also:

BasicSearchQuery.setDistinct(boolean), SearchQuery.isDistinct()

setMaxNumber

public Query setMaxNumber(int arg0)

Description copied from interface: Query

Limits the query-result to maxNumber records.

Specified by:

setMaxNumber in interface Query

Parameters:

arg0 - max number of results

Returns:

Query

See Also:

BasicSearchQuery.setMaxNumber(int)

getCleanConstraint

public Constraint getCleanConstraint()

Description copied from interface: Query

Gets the 'clean' constraint on this query. I.e. the constraint which were automaticly added because of security are stripped away, and it is garanteed that you get back what you put in. It is adviced that you use this in stead of SearchQuery#getConstraint, because that function is used by the Query handlers, which do need the security constraints. But otherwise you don't want to see those.

Specified by:

getCleanConstraint in interface Query

Returns:

Constraint

createConstraint

public FieldValueConstraint createConstraint(StepField arg0,
                                             Object arg1)

Description copied from interface: Query

Create a constraint (for use with this Query object). The given field must equal the given value 'v'.

Specified by:

createConstraint in interface Query

Parameters:

arg0 - field

arg1 - value

Returns:

FieldValueConstraint

createConstraint

public FieldNullConstraint createConstraint(StepField arg0)

Description copied from interface: Query

Create a constraint (for use with this Query object). The given field must be 'null'.

Specified by:

createConstraint in interface Query

Parameters:

arg0 - Stepfield

Returns:

FieldNullConstraint

createConstraint

public FieldValueInQueryConstraint createConstraint(StepField arg0,
                                                    Query arg1)

Specified by:

createConstraint in interface Query

createConstraint

public FieldValueInConstraint createConstraint(StepField arg0,
                                               SortedSet<?> arg1)

Description copied from interface: Query

Create a constraint (for use with this Query object). The given field value must be contained by the given set of values. If the given set is empty, a FieldValueInConstraint will be constructed for the number field in stead ('number IN (-1)'), which ensures that also in that case the logical thing will happen. (' IN ()' fails in most databases).

Specified by:

createConstraint in interface Query

Parameters:

arg0 - field

arg1 - value

Returns:

the new Constraint.

createConstraint

public FieldValueBetweenConstraint createConstraint(StepField arg0,
                                                    Object arg1,
                                                    Object arg2)

Description copied from interface: Query

Create a constraint (for use with this Query object). The given field must lie between the two given values.

Specified by:

createConstraint in interface Query

Parameters:

arg0 - field

arg1 - value one

arg2 - value two

Returns:

FieldValueBetweenConstraint

createConstraint

public FieldValueConstraint createConstraint(StepField arg0,
                                             int arg1,
                                             Object arg2,
                                             int arg3)

Description copied from interface: Query

Create a constraint (for use with this Query object). The given date field and the given value 'v', combined with given operator must evaluate to true for the specified date part.

Specified by:

createConstraint in interface Query

Parameters:

arg0 - field

arg1 - operator

arg2 - value

arg3 - part of the date value

Returns:

FieldValueConstraint

createConstraint

public FieldValueConstraint createConstraint(StepField arg0,
                                             int arg1,
                                             Object arg2)

Description copied from interface: Query

Create a constraint (for use with this Query object). The given field and the given value 'v', combined with given operator must evaluate to true.

Specified by:

createConstraint in interface Query

Parameters:

arg0 - field

arg1 - operator

arg2 - value

Returns:

FieldValueConstraint

createConstraint

public CompositeConstraint createConstraint(Constraint arg0,
                                            int arg1,
                                            Constraint arg2)

Description copied from interface: Query

Combines two Constraints to one new one, using a boolean operator (AND or OR). Every new constraint must be combined with the ones you already have with such a new CompositeConstraint. If the first constraint is a composite constraint (with the same logical operator), then the second one will simply be added.

Specified by:

createConstraint in interface Query

Parameters:

arg0 - constraint one

arg1 - operator (CompositeConstraint.LOGICAL_AND, CompositeConstraint.LOGICAL_OR)

arg2 - constraint two

Returns:

a Composite constraint (might not be a new one)

createConstraint

public LegacyConstraint createConstraint(String arg0)

Description copied from interface: Query

Create a constraint (for use with this Query object). The argument is a string, as also can be used as an argument of the 'non-query' getList. This should be considered legacy.

Specified by:

createConstraint in interface Query

Parameters:

arg0 - String with LegacyConstraint

Returns:

LegacyConstraint

See Also:

Cloud.getList(String startNodes, String nodePath, String fields, String constraints, String orderby, String directions, String searchDir, boolean distinct), NodeManager.getList(String constraints, String orderby, String directions)

createConstraint

public CompareFieldsConstraint createConstraint(StepField arg0,
                                                int arg1,
                                                StepField arg2)

Description copied from interface: Query

Create a constraint (for use with this Query object). The two given fields , combined with given operator must evaluate to true.

Specified by:

createConstraint in interface Query

Parameters:

arg0 - field

arg1 - operator

arg2 - value

Returns:

CompareFieldsConstraint

setInverse

public Constraint setInverse(Constraint arg0,
                             boolean arg1)

Description copied from interface: Query

Changes the given constraint's 'inverse' (if applicable). Default it is (of course) false.

Specified by:

setInverse in interface Query

Parameters:

arg0 - constraint

arg1 - inverse

Returns:

Inversed constraint

setConstraint

public void setConstraint(Constraint arg0)

Description copied from interface: Query

The (composite) constraint can actually be set into the query with this method.

Specified by:

setConstraint in interface Query

Parameters:

arg0 - constraint

addSortOrder

public SortOrder addSortOrder(StepField arg0,
                              int arg1,
                              boolean arg2,
                              int arg3)

Description copied from interface: Query

Adds an order on a certain field.

Specified by:

addSortOrder in interface Query

Parameters:

arg0 - field

arg1 - SortOrder.ORDER_ASCENDING or SortOrder.ORDER_DESCENDING

arg2 - case sensitivity

arg3 - part to sort on for a date value

Returns:

new SortOrder

See Also:

BasicSearchQuery.addSortOrder(org.mmbase.storage.search.StepField)

addSortOrder

public SortOrder addSortOrder(StepField arg0,
                              int arg1)

Description copied from interface: Query

Defaulting version of Query.addSortOrder(StepField, int, boolean, int) (sorting case insensitively, and no date parts).

Specified by:

addSortOrder in interface Query

Parameters:

arg0 - field

arg1 - SortOrder.ORDER_ASCENDING or SortOrder.ORDER_DESCENDING

Returns:

new SortOrder

addSortOrder

public SortOrder addSortOrder(StepField arg0,
                              int arg1,
                              boolean arg2)

Description copied from interface: Query

Defaulting version of Query.addSortOrder(StepField, int, boolean, int) (no date parts)

Specified by:

addSortOrder in interface Query

Parameters:

arg0 - field

arg1 - SortOrder.ORDER_ASCENDING or SortOrder.ORDER_DESCENDING

arg2 - case sensitivity

Returns:

new SortOrder

cloneWithoutFields

public Query cloneWithoutFields()

Description copied from interface: Query

Clones this object, only without the fields

Specified by:

cloneWithoutFields in interface Query

Returns:

Cloned Query

aggregatingClone

public Query aggregatingClone()

Description copied from interface: Query

Creates an unused aggregate clone of this query. If this query is not itself aggregated, all fields are removed (but the constraints on them remain), and you can add aggregated fields then.

Specified by:

aggregatingClone in interface Query

Returns:

Cloned Query

removeImplicitFields

public void removeImplicitFields()

Specified by:

removeImplicitFields in interface Query

isUsed

public boolean isUsed()

Description copied from interface: Query

Whether this query was used or not. If is was used, then you cannot modify it anymore (would kill caches, and references to 'original query' would get invalid)

Specified by:

isUsed in interface Query

Returns:

query already used or not

addStep

public Step addStep(NodeManager arg0)

Description copied from interface: Query

Adds a NodeManager to this Query. This can normally be done only once. After that you need to use (one of the) 'addRelationStep'.

Specified by:

addStep in interface Query

Parameters:

arg0 - The nodeManager associated with the step.

Returns:

The 'step' wrapping the NodeManager.

See Also:

Query.addRelationStep(NodeManager)

addField

public StepField addField(Step arg0,
                          Field arg1)

Description copied from interface: Query

Adds a field to a step.

Specified by:

addField in interface Query

Parameters:

arg0 - step to add field to

arg1 - field to add

Returns:

new StepField

addField

public StepField addField(String arg0)

Description copied from interface: Query

Adds a field by string

Specified by:

addField in interface Query

Parameters:

arg0 - field to add

Returns:

new StepField

addNode

public void addNode(Step arg0,
                    Node arg1)

Description copied from interface: Query

Adds a node to a step.

Specified by:

addNode in interface Query

Parameters:

arg0 - step

arg1 - node to add

addNode

public void addNode(Step arg0,
                    int arg1)

Specified by:

addNode in interface Query

Parameters:

arg0 - query step

arg1 - node number

toSql

public String toSql()

Description copied from interface: Query

Shows the query in a human-readable SQL form. This is probably not the query which will actually be sent to the database. This method is provided because 'toString' on a Query object is pretty complete, but pretty undigestable for mere mortals too. Implementions can also implement getSql(), which would make this available in e.g. EL too.

Specified by:

toSql in interface Query

Returns:

human-readable SQL

getCloud

public Cloud getCloud()

Description copied from interface: Query

Returns the Cloud for which this Query was defined.

Specified by:

getCloud in interface Query

Returns:

Cloud

markUsed

public boolean markUsed()

Description copied from interface: Query

Mark this query 'used'. It has to be copied first, if you want to add things to it.

Specified by:

markUsed in interface Query

Specified by:

markUsed in interface SearchQuery

Returns:

if this query is was used before this method call

getStep

public Step getStep(String arg0)

Description copied from interface: Query

Returns the step with given alias, or null if it is not present

Specified by:

getStep in interface Query

Parameters:

arg0 - Alias for the step (may also be tableName, in which case the first step for this table is returned)

Returns:

step with given alias

getList

public NodeList getList()

Description copied from interface: Query

Executes the query and returns the resulting node list.

Specified by:

getList in interface Query

Returns:

resulting node list

setAlias

public void setAlias(Step arg0,
                     String arg1)

Description copied from interface: Query

Sets the alias to the given step.

Specified by:

setAlias in interface Query

Parameters:

arg0 - step to add the alias for

arg1 - The alias which must be given to the step. If it is "" an alias should be generated. 'null' removes the alias.

setCaseSensitive

public FieldConstraint setCaseSensitive(FieldConstraint arg0,
                                        boolean arg1)

Description copied from interface: Query

Changes the given constraint's 'case sensitivity' (if applicable). Default it is true.

Specified by:

setCaseSensitive in interface Query

Parameters:

arg0 - constraint to change

arg1 - case sensitivity

Returns:

modified FieldConstraint

clone

public Query clone()

Description copied from interface: Query

Create an (unused) clone

Specified by:

clone in interface Query

Specified by:

clone in interface PublicCloneable<Query>

Overrides:

clone in class Object

Returns:

Cloned Query

setOffset

public Query setOffset(int arg0)

Description copied from interface: Query

Offsets the query-result with offset records.

Specified by:

setOffset in interface Query

Parameters:

arg0 - offset in results

Returns:

Query

See Also:

BasicSearchQuery.setOffset(int)

getMaxNumber

public int getMaxNumber()

Description copied from interface: SearchQuery

Gets the maximum number of results to be returned, or -1 if the number of results to be returned is unlimited.

Note: limiting the number of results may not be supported by the database layer.

Specified by:

getMaxNumber in interface SearchQuery

isDistinct

public boolean isDistinct()

Description copied from interface: SearchQuery

Tests if the search request is to return distinct results. In that case duplicate nodes will be removed from the result.

This corresponds to the use of "DISTINCT" in SQL SELECT-syntax .

Specified by:

isDistinct in interface SearchQuery

getSortOrders

public List<SortOrder> getSortOrders()

Description copied from interface: SearchQuery

Gets the SortOrder objects in the order they are to be applied. This specifies the sorting order of the search results.

This corresponds to the ORDER BY clause in SQL SELECT syntax.

Specified by:

getSortOrders in interface SearchQuery

getConstraint

public Constraint getConstraint()

Description copied from interface: SearchQuery

Gets the constraints on the search results.

This corresponds to (part of) the constraints in the WHERE-clause in SQL SELECT-syntax.

Specified by:

getConstraint in interface SearchQuery

isAggregating

public boolean isAggregating()

Description copied from interface: SearchQuery

Tests if this is an aggregating query, i.e. containing aggregated fields.

Specified by:

isAggregating in interface SearchQuery

getSteps

public List<Step> getSteps()

Description copied from interface: SearchQuery

Gets the steps in the search request.

This corresponds to the tables in SQL SELECT-syntax.

Specified by:

getSteps in interface SearchQuery

getFields

public List<StepField> getFields()

Description copied from interface: SearchQuery

Gets the stepfields in the search request.

This corresponds to the fields in SQL SELECT-syntax.

Specified by:

getFields in interface SearchQuery

getOffset

public int getOffset()

Description copied from interface: SearchQuery

Gets the (zerobased) offset in the list of results, of the first result to return. Note that, since it is zerobased, it is equal to the number of results that are skipped.

Note: skipping results may not be supported by the database layer.

Specified by:

getOffset in interface SearchQuery

getCachePolicy

public CachePolicy getCachePolicy()

Description copied from interface: Cacheable

Returns the CachePolicy of the object.

Specified by:

getCachePolicy in interface Cacheable

Returns:

the CachePolicy object.

setCachePolicy

public void setCachePolicy(CachePolicy arg0)

Description copied from interface: Cacheable

Sets the CachePolicy of the query.

Specified by:

setCachePolicy in interface Cacheable

Parameters:

arg0 - the CachePolicy object.

unwrap

public SearchQuery unwrap()

Specified by:

unwrap in interface SearchQueryWrapper

getWrappedObject

public RemoteNodeQuery getWrappedObject()

Specified by:

getWrappedObject in interface MappedObject

Overrides:

getWrappedObject in class MappedObject_Proxy<RemoteNodeQuery>