| org.mmbase.storage.search.RelationStep
All known Subclasses: org.mmbase.storage.search.implementation.BasicRelationStep,
| RelationStep | | public interface RelationStep extends Step(Code) | | A relationstep refers to a table of relations between the previous and next step. Relationstep are used to create a path of related objects.
This corresponds to a constraint joining the three tables in SQL SELECT-syntax.
Note that tables can also be joined using FieldCompareConstraints.
author:
Rob van Maris
version:
$Id: RelationStep.java,v 1.10 2007/12/06 08:13:36 michiel Exp $
since:
MMBase-1.7 |
| Field Summary | |
| final public static String[] | DIRECTIONALITY_DESCRIPTIONS
Directionality names corresponding to the direction values. | | int | DIRECTIONS_ALL
Directionality following relations both ways, including unidirectional relations. | | int | DIRECTIONS_BOTH
Directionality following relations both ways (source to destination AND destination to source). | | int | DIRECTIONS_DESTINATION
Directionality following relations from source to destination.
E.g. | | int | DIRECTIONS_EITHER
Directionality following relations from destination to source.
E.g. | | int | DIRECTIONS_SOURCE
Directionality following relations from destination to source.
E.g. |
| DIRECTIONALITY_DESCRIPTIONS | | final public static String[] DIRECTIONALITY_DESCRIPTIONS(Code) | | Directionality names corresponding to the direction values.
As a result DIRECTIONALITY_DESCRIPTIONS[directionality] is the directionality
name: "both", "destination", "source", "all" or "either".
|
| DIRECTIONS_ALL | | int DIRECTIONS_ALL(Code) | | Directionality following relations both ways, including unidirectional relations.
This value ignores the value of the checkedDirectionality property.
|
| DIRECTIONS_BOTH | | int DIRECTIONS_BOTH(Code) | | Directionality following relations both ways (source to destination AND destination to source).
Whether unidirectional relations are shown is dependent on the value of the checkedDirectionality property.
|
| DIRECTIONS_DESTINATION | | int DIRECTIONS_DESTINATION(Code) | | Directionality following relations from source to destination.
E.g. where the previous step is source and the next step is destination.
Whether unidirectional relations are shown is dependent on the value of the checkedDirectionality property.
|
| DIRECTIONS_EITHER | | int DIRECTIONS_EITHER(Code) | | Directionality following relations from destination to source.
E.g. where the previous step is destination and the next step is source.
Whether unidirectional relations are shown is dependent on the value of the checkedDirectionality property.
|
| DIRECTIONS_SOURCE | | int DIRECTIONS_SOURCE(Code) | | Directionality following relations from destination to source.
E.g. where the previous step is destination and the next step is source.
This value ignores the value of the checkedDirectionality property.
|
| equals | | public boolean equals(Object obj)(Code) | | Compares this relationstep to the specified object. The result is
true if and only if the argument is a non-null
RelationStep object with the same directionality and role,
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: Step.equals |
| getCheckedDirectionality | | boolean getCheckedDirectionality()(Code) | | Gets the value of the checkedDirectionality property. This property
determines how uni/bi-directionality affects which relations are
followed from destination to source, when the directionality property
is set to
RelationStep.DIRECTIONS_SOURCE or
RelationStep.DIRECTIONS_BOTH .
When this value is true, only bi-directional relations are followed
from destination to source.
Otherwise unidirectional relations are followed from destination to
source as well.
|
| getDirectionality | | int getDirectionality()(Code) | | Gets the directionality mode used with this relation. This is one of
values defined in this class.
|
| getPrevious | | Step getPrevious()(Code) | | Gets the previous step.
|
| hashCode | | public int hashCode()(Code) | | |
| toString | | public String toString()(Code) | | Returns a string representation of this RelationStep.
The string representation has the form
"RelationStep(tablename:<tablename>, alias:<alias>,
nodes:<nodes>, dir:<dir>, role:<role>)"
where
A string representation of this RelationStep. |
|
|