org.xcmis.search.model.column
Class Column

java.lang.Object
  org.xcmis.search.model.column.Column

All Implemented Interfaces:

Serializable, QueryElement

public class Column
extends Object
implements QueryElement

Version:

$Id: Column.java 34360 2009-07-22 23:58:59Z ksm $

Author:

Sergey Kabashnyuk

See Also:

Serialized Form

Nested Class Summary

static interface	Column.ColumnFunction Basic interface for column operations.
static class	Column.ScoreFunction This is a predicate function that encapsulates the full-text search capability that MAY be provided by a service.

Constructor Summary

Column(Column.ColumnFunction columnFunction, String columnName)

Column(SelectorName selectorName)
Include a column for each of the single-valued, accessible properties on the node identified by the selector.

Column(SelectorName selectorName, String propertyName, String columnName)
A column with the given name representing the named property on the node identified by the selector.

Method Summary

void	accept(QueryObjectModelVisitor visitor) Accepts a visitor and calls the appropriate visit method depending on the type of this QOM node.
boolean	equals(Object obj)
Column.ColumnFunction	getColumnFunction()
String	getColumnName() Get the name of the column.
String	getPropertyName() Get the name of the property that this column represents.
SelectorName	getSelectorName() Get the name of the selector for the node.
int	hashCode()
boolean	isFunction()
String	toString()
Column	with(SelectorName newSelectorName) Create a copy of this Column except that uses the supplied selector name instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

Column

public Column(SelectorName selectorName)

Include a column for each of the single-valued, accessible properties on the node identified by the selector.

Parameters:

selectorName - the selector name

Column

public Column(SelectorName selectorName,
              String propertyName,
              String columnName)

A column with the given name representing the named property on the node identified by the selector.

Parameters:

selectorName - the selector name

propertyName - the name of the property

columnName - the name of the column

Column

public Column(Column.ColumnFunction columnFunction,
              String columnName)

Method Detail

accept

public void accept(QueryObjectModelVisitor visitor)
            throws VisitException

Description copied from interface: QueryElement

Accepts a visitor and calls the appropriate visit method depending on the type of this QOM node.

Specified by:

accept in interface QueryElement

Parameters:

visitor - the visitor.

Throws:

VisitException

See Also:

QueryElement.accept(org.xcmis.search.QueryObjectModelVisitor)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getColumnName

public final String getColumnName()

Get the name of the column.

Returns:

the column name; or null if this represents all selectable columsn on the selector

getPropertyName

public final String getPropertyName()

Get the name of the property that this column represents.

Returns:

the property name; or null if this represents all selectable columns on the selector

isFunction

public final boolean isFunction()

Returns:

true of columnt is function

getColumnFunction

public Column.ColumnFunction getColumnFunction()

Returns:

the columnFunction

getSelectorName

public final SelectorName getSelectorName()

Get the name of the selector for the node.

Returns:

the selector name; never null

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

with

public Column with(SelectorName newSelectorName)

Create a copy of this Column except that uses the supplied selector name instead.

Parameters:

newSelectorName - the new selector name

Returns:

a new Column with the supplied selector name and the property and column names from this object; never null

Throws:

IllegalArgumentException - if the supplied selector name is null