| org.mmbase.storage.search.StepField
All known Subclasses: org.mmbase.storage.search.implementation.BasicStepField,
StepField | public interface StepField (Code) | | A stepfield refers to a field in a step.
Each stepfield has an unique alias to identify it.
This corresponds to a prefixed fieldname in a SQL SELECT-syntax.
author: Rob van Maris version: $Id: StepField.java,v 1.6 2007/12/06 08:13:36 michiel Exp $ since: MMBase-1.7 |
Method Summary | |
public boolean | equals(Object obj) Compares this stepfield to the specified object. | String | getAlias() Gets the alias for the associated field. | String | getFieldName() Gets the name of the associated field (without prefix). | Step | getStep() Gets the step associated with this fieldstep. | int | getType() Gets the type of the associated field. | public int | hashCode() | public String | toString() Returns a string representation of this StepField. |
equals | public boolean equals(Object obj)(Code) | | Compares this stepfield to the specified object. The result is
true if and only if the argument is a non-null
StepField object associated with the same field, using the same alias.
Parameters: obj - The object to compare with. true if the objects are equal,false otherwise. |
getAlias | String getAlias()(Code) | | Gets the alias for the associated field.
This corresponds to the field alias in SQL SELECT-syntax.
|
getFieldName | String getFieldName()(Code) | | Gets the name of the associated field (without prefix).
This corresponds to the fieldname in SQL SELECT-syntax.
|
getStep | Step getStep()(Code) | | Gets the step associated with this fieldstep.
|
hashCode | public int hashCode()(Code) | | |
toString | public String toString()(Code) | | Returns a string representation of this StepField.
The string representation has the form
"StepField(step:<step>, fieldname:<fieldname>, alias:<alias>)"
where
- <step> is the step alias returned by
getStep().getAlias() or,
when the step alias is null , the step tablename
returned by getStep().getTableName() .
- <fieldname> is the fieldname returned by
StepField.getFieldName getFieldName()
- <alias> is the alias returned by
StepField.getAlias getAlias()
A string representation of this StepField. |
|
|