| org.mmbase.storage.search.Step
All known Subclasses: org.mmbase.storage.search.implementation.BasicStep,
| Step | | public interface Step (Code) | | A step refers to a table in a search request. Several steps may refer to the same table, therefore each step has an unique alias to identify it.
This corresponds to a table name and alias in SQL SELECT-syntax.
author:
Rob van Maris
version:
$Id: Step.java,v 1.5 2007/12/06 08:13:36 michiel Exp $
since:
MMBase-1.7 |
| Method Summary | |
| public Step | addNode(int nodeNumber)
Adds node to nodes.
Parameters:
nodeNumber - The nodenumber of the node. | | public boolean | equals(Object obj)
Compares this step to the specified object. | | String | getAlias()
Gets the alias associated with this step. | | SortedSet<Integer> | getNodes()
Gets nodenumbers for nodes that must be included in this step. | | String | getTableName()
Gets the name of the table referred to by this step. | | public int | hashCode()
| | public String | toString()
Returns a string representation of this Step. |
| addNode | | public Step addNode(int nodeNumber)(Code) | | Adds node to nodes.
Parameters:
nodeNumber - The nodenumber of the node. This BasicStep instance.
throws:
IllegalArgumentException - when an invalid argument is supplied. |
| equals | | public boolean equals(Object obj)(Code) | | Compares this step to the specified object. The result is
true if and only if the argument is a non-null
Step, but not RelationStep, object associated with the same tablename,
using the same alias and including the same nodes.
Parameters:
obj - The object to compare with. true if the objects are equal,false otherwise.
See Also: RelationStep.equals |
| getAlias | | String getAlias()(Code) | | Gets the alias associated with this step.
This corresponds to a table alias in SQL SELECT-syntax.
|
| getNodes | | SortedSet<Integer> getNodes()(Code) | | Gets nodenumbers for nodes that must be included in this step.
A null value indicates that no such constraint is applied.
This corresponds to a "number IN (....)" constraint in SQL SELECT syntax.
Note that this can also be achieved by using a FieldValueInConstraint on the "number" field.
|
| getTableName | | String getTableName()(Code) | | Gets the name of the table referred to by this step.
This corresponds to a table name in SQL SELECT-syntax.
|
| hashCode | | public int hashCode()(Code) | | |
| toString | | public String toString()(Code) | | Returns a string representation of this Step.
The string representation has the form
"Step(tablename:<tablename>, alias:<alias>, nodes:<nodes>)"
where
- <tablename> is the tablename returnedby
Step.getTableName getTableName()
- <alias> is the alias returned by
Step.getAlias getAlias()
- <nodes> is the string representation of the ordered list
of nodenumbers returned by
Step.getNodes getNodes()
A string representation of this Step. |
|
|