org.mmbase.storage.search
Interface StepField

All Known Subinterfaces:

AggregatedField

All Known Implementing Classes:

BasicAggregatedField, BasicStepField

public interface StepField

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.

Since:

MMBase-1.7

Version:

$Id: StepField.java 41186 2010-02-26 17:54:31Z michiel $

Author:

Rob van Maris

Method Summary

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.
int	hashCode()
void	setUnmodifiable()
String	toString() Returns a string representation of this StepField.

Method Detail

getFieldName

String getFieldName()

Gets the name of the associated field (without prefix).

This corresponds to the fieldname in SQL SELECT-syntax.

getAlias

String getAlias()

Gets the alias for the associated field.

This corresponds to the field alias in SQL SELECT-syntax.

getStep

Step getStep()

Gets the step associated with this fieldstep.

getType

int getType()

Gets the type of the associated field. This is one of the values defined in Field.

equals

boolean equals(Object obj)

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.

Overrides:

equals in class Object

Parameters:

obj - The object to compare with.

Returns:

true if the objects are equal, false otherwise.

hashCode

int hashCode()

Overrides:

hashCode in class Object

toString

String toString()

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 getFieldName()
• <alias> is the alias returned by getAlias()

Overrides:

toString in class Object

Returns:

A string representation of this StepField.

setUnmodifiable

void setUnmodifiable()

Since:

MMBase-1.9.2