Package mondrian.olap

Enum MatchType

java.lang.Object

java.lang.Enum<MatchType>

mondrian.olap.MatchType

All Implemented Interfaces:

Serializable, Comparable<MatchType>

public enum MatchType
extends Enum<MatchType>

MatchType enumerates the allowable match modes when searching for a member based on its unique name.

Author:

Zelaine Fong

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFTER	If no exact match, return the next member
BEFORE	If no exact match, return the preceding member
EXACT	Match the unique name exactly
EXACT_SCHEMA	Match the unique name exactly, do not query database for members
FIRST	Return the first child
LAST	Return the last child

Method Summary

Modifier and Type	Method	Description
boolean	isExact()	Return true if either Exact or Exact Schema value is selected.
static MatchType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MatchType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXACT_SCHEMA

public static final MatchType EXACT_SCHEMA

Match the unique name exactly, do not query database for members

EXACT

public static final MatchType EXACT

Match the unique name exactly

BEFORE

public static final MatchType BEFORE

If no exact match, return the preceding member

AFTER

public static final MatchType AFTER

If no exact match, return the next member

FIRST

public static final MatchType FIRST

Return the first child

LAST

public static final MatchType LAST

Return the last child

Method Detail

values

public static MatchType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MatchType c : MatchType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MatchType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isExact

public boolean isExact()

Return true if either Exact or Exact Schema value is selected.

Returns:

true if exact