com.appiancorp.common.query

Class Column

java.lang.Object

com.appiancorp.common.query.ColumnAlias

com.appiancorp.common.query.Column

Direct Known Subclasses:

AggregationColumn

@GwtCompatible
public class Column
extends ColumnAlias

Immutable bean representing the column dot notation, its alias and its visibility (if it should be shown to the client or not).

An instance can only be obtain by using the helper class QueryBuilder.Selector

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCAL_PART
static javax.xml.namespace.QName	QNAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Column() Initializes a newly created Column object
	Column(Column column) Copy constructor
protected	Column(java.lang.String field, java.lang.String alias, boolean visible) Constructs a new Column for a field with the given field name

Method Summary

Modifier and Type	Method and Description
protected static java.lang.StringBuilder	appendForToString(java.lang.StringBuilder sb, boolean isVisible) Helper function which appends the visibility string translation to a given StringBuilder
protected boolean	canEquals(java.lang.Object obj) Checks if this instance can compare against the given object.
boolean	equals(java.lang.Object obj)
static java.util.Map<java.lang.String,java.lang.String>	getAliasToFieldPathMap(Projection<? extends Column> proj) Gets a Map from alias to field path for the Column instances of the given Projection.
int	hashCode()
boolean	isVisible() Returns true if this column is visible.
java.lang.String	toString()

Methods inherited from class com.appiancorp.common.query.ColumnAlias

appendForToString, getAlias, getField

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_PART

public static final java.lang.String LOCAL_PART

See Also:

Constant Field Values

QNAME

public static final javax.xml.namespace.QName QNAME

Constructor Detail

Column

protected Column()

Initializes a newly created Column object

Column

protected Column(java.lang.String field,
                 java.lang.String alias,
                 boolean visible)

Constructs a new Column for a field with the given field name

Parameters:

field - a field name

alias - an alias name for this column

visible - determines if this column will be visible or not.

Column

public Column(Column column)

Copy constructor

Parameters:

column - a Column

Method Detail

isVisible

public boolean isVisible()

Returns true if this column is visible.

Returns:

true if this column is visible; otherwise false

hashCode

public int hashCode()

Overrides:

hashCode in class ColumnAlias

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ColumnAlias

canEquals

protected boolean canEquals(java.lang.Object obj)

Description copied from class: ColumnAlias

Checks if this instance can compare against the given object.

Overrides:

canEquals in class ColumnAlias

Parameters:

obj - an Object

Returns:

true if the given object is an instanceof this class.

toString

public java.lang.String toString()

Overrides:

toString in class ColumnAlias

appendForToString

protected static java.lang.StringBuilder appendForToString(java.lang.StringBuilder sb,
                                                           boolean isVisible)

Helper function which appends the visibility string translation to a given StringBuilder

Parameters:

sb - a StringBuilder

isVisible - boolean value indicating the visibility of the columns

Returns:

the same StringBuilder by appending the visibility

getAliasToFieldPathMap

public static java.util.Map<java.lang.String,java.lang.String> getAliasToFieldPathMap(Projection<? extends Column> proj)

Gets a Map from alias to field path for the Column instances of the given Projection.

Parameters:

proj - a Projection

Returns:

alias to field path Map