mondrian.xmla
Class RowsetDefinition.Column

java.lang.Object
  mondrian.xmla.RowsetDefinition.Column

Enclosing class:

RowsetDefinition

static class RowsetDefinition.Column
extends Object

Field Summary

(package private) String	description
(package private) Enumeration	enumeration
(package private) String	name
(package private) static boolean	NOT_RESTRICTION This is used as the false value for the restriction parameter.
(package private) boolean	nullable
(package private) static boolean	ONE_MAX This is used as the false value for the unbounded parameter.
(package private) static boolean	OPTIONAL This is used as the true value for the nullable parameter.
(package private) static boolean	REQUIRED This is used as the false value for the nullable parameter.
(package private) boolean	restriction
(package private) static boolean	RESTRICTION This is used as the true value for the restriction parameter.
(package private) RowsetDefinition.Type	type
(package private) boolean	unbounded
(package private) static boolean	UNBOUNDED This is used as the true value for the unbounded parameter.

Constructor Summary

RowsetDefinition.Column(String name, RowsetDefinition.Type type, Enumeration enumeratedType, boolean restriction, boolean nullable, boolean unbounded, String description)

RowsetDefinition.Column(String name, RowsetDefinition.Type type, Enumeration enumeratedType, boolean restriction, boolean nullable, String description)
Creates a column.

Method Summary

protected Object	get(Object row) Retrieves a value of this column from a row.
String	getColumnType()
protected Object	getFromAccessor(Object row) Retrieves the value of this column "MyColumn" by calling a method called "getMyColumn()".
protected Object	getFromField(Object row) Retrieves the value of this column "MyColumn" from a field called "myColumn".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESTRICTION

static final boolean RESTRICTION

This is used as the true value for the restriction parameter.

See Also:

Constant Field Values

NOT_RESTRICTION

static final boolean NOT_RESTRICTION

This is used as the false value for the restriction parameter.

See Also:

Constant Field Values

REQUIRED

static final boolean REQUIRED

This is used as the false value for the nullable parameter.

See Also:

Constant Field Values

OPTIONAL

static final boolean OPTIONAL

This is used as the true value for the nullable parameter.

See Also:

Constant Field Values

ONE_MAX

static final boolean ONE_MAX

This is used as the false value for the unbounded parameter.

See Also:

Constant Field Values

UNBOUNDED

static final boolean UNBOUNDED

This is used as the true value for the unbounded parameter.

See Also:

Constant Field Values

name

final String name

type

final RowsetDefinition.Type type

enumeration

final Enumeration enumeration

description

final String description

restriction

final boolean restriction

nullable

final boolean nullable

unbounded

final boolean unbounded

Constructor Detail

RowsetDefinition.Column

RowsetDefinition.Column(String name,
                        RowsetDefinition.Type type,
                        Enumeration enumeratedType,
                        boolean restriction,
                        boolean nullable,
                        String description)

Creates a column.

Parameters:

name - Name of column

type - A RowsetDefinition.Type value

enumeratedType - Must be specified for enumeration or array of enumerations

description - Description of column

restriction - Whether column can be used as a filter on its rowset

nullable - Whether column can contain null values

Pre-condition:

type != null, (type == Type.Enumeration || type == Type.EnumerationArray || type == Type.EnumString) == (enumeratedType != null), description == null || description.indexOf('\r') == -1

RowsetDefinition.Column

RowsetDefinition.Column(String name,
                        RowsetDefinition.Type type,
                        Enumeration enumeratedType,
                        boolean restriction,
                        boolean nullable,
                        boolean unbounded,
                        String description)

Method Detail

get

protected Object get(Object row)

Retrieves a value of this column from a row. The base implementation uses reflection to call an accessor method; a derived class may provide a different implementation.

Parameters:

row - Row

getFromField

protected final Object getFromField(Object row)

Retrieves the value of this column "MyColumn" from a field called "myColumn".

Parameters:

row - Current row

Returns:

Value of given this property of the given row

getFromAccessor

protected final Object getFromAccessor(Object row)

Retrieves the value of this column "MyColumn" by calling a method called "getMyColumn()".

Parameters:

row - Current row

Returns:

Value of given this property of the given row

getColumnType

public String getColumnType()