org.teiid.query.sql.lang

Class Option

java.lang.Object

org.teiid.query.sql.lang.Option

All Implemented Interfaces:

Cloneable, LanguageObject

public class Option
extends Object
implements LanguageObject

Represents MetaMatrix extension options to normal SQL. Options are declared in a list after the OPTION keyword, such as: "OPTION SHOWPLAN DEBUG".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Option.MakeDep

Nested classes/interfaces inherited from interface org.teiid.query.sql.LanguageObject

LanguageObject.Util

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAKEDEP
static String	MAKENOTDEP
static String	OPTIONAL

Constructor Summary

Constructors

Constructor and Description
Option() Construct a default instance of the Option clause.

Method Summary

Modifier and Type	Method and Description
void	acceptVisitor(LanguageVisitor visitor) Method for accepting a visitor.
void	addDependentGroup(String group) Add group to make dependent
void	addDependentGroup(String group, Option.MakeDep makedep)
void	addIndependentGroup(String group, Option.MakeDep makedep)
void	addNoCacheGroup(String group) Add group that overrides the default behavior of Materialized View feautre to route the query to the primary virtual group transformation instead of the Materialized View transformation.
void	addNotDependentGroup(String group) Add group to make dependent
Object	clone() Return deep copy of this option object
boolean	equals(Object obj) Compare two Option clauses for equality.
List<String>	getDependentGroups() Get all groups to make dependent
List<Option.MakeDep>	getMakeDepOptions()
List<String>	getMakeIndependentGroups()
List<Option.MakeDep>	getMakeIndependentOptions()
List<String>	getNoCacheGroups() Get all groups that override the default behavior of Materialized View feautre to route the query to the primary virtual group transformation instead of the Materialized View transformation.
List<String>	getNotDependentGroups() Get all groups to make dependent
int	hashCode() Get hash code for Option.
boolean	isNoCache()
void	setNoCache(boolean noCache)
String	toString() Returns a string representation of an instance of this class.

Methods inherited from class java.lang.Object

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

Field Detail

MAKEDEP

public static final String MAKEDEP

See Also:

Constant Field Values

MAKENOTDEP

public static final String MAKENOTDEP

See Also:

Constant Field Values

OPTIONAL

public static final String OPTIONAL

See Also:

Constant Field Values

Constructor Detail

Option

public Option()

Construct a default instance of the Option clause.

Method Detail

addDependentGroup

public void addDependentGroup(String group)

Add group to make dependent

Parameters:

group - Group to make dependent

addDependentGroup

public void addDependentGroup(String group,
                              Option.MakeDep makedep)

addIndependentGroup

public void addIndependentGroup(String group,
                                Option.MakeDep makedep)

getDependentGroups

public List<String> getDependentGroups()

Get all groups to make dependent

Returns:

List of String defining groups to be made dependent, may be null if no groups

getMakeDepOptions

public List<Option.MakeDep> getMakeDepOptions()

getMakeIndependentOptions

public List<Option.MakeDep> getMakeIndependentOptions()

getMakeIndependentGroups

public List<String> getMakeIndependentGroups()

addNotDependentGroup

public void addNotDependentGroup(String group)

Add group to make dependent

Parameters:

group - Group to make dependent

getNotDependentGroups

public List<String> getNotDependentGroups()

Get all groups to make dependent

Returns:

List of String defining groups to be made dependent, may be null if no groups

addNoCacheGroup

public void addNoCacheGroup(String group)

Add group that overrides the default behavior of Materialized View feautre to route the query to the primary virtual group transformation instead of the Materialized View transformation.

Parameters:

group - Group that overrides the default behavior of Materialized View

getNoCacheGroups

public List<String> getNoCacheGroups()

Get all groups that override the default behavior of Materialized View feautre to route the query to the primary virtual group transformation instead of the Materialized View transformation.

Returns:

List of String defining groups that overrides the default behavior of Materialized View, may be null if there are no groups

isNoCache

public boolean isNoCache()

setNoCache

public void setNoCache(boolean noCache)

acceptVisitor

public void acceptVisitor(LanguageVisitor visitor)

Description copied from interface: LanguageObject

Method for accepting a visitor. It is the responsibility of the language object to call back on the visitor.

Specified by:

acceptVisitor in interface LanguageObject

Parameters:

visitor - Visitor being used

toString

public String toString()

Returns a string representation of an instance of this class.

Overrides:

toString in class Object

Returns:

String representation of object

equals

public boolean equals(Object obj)

Compare two Option clauses for equality.

Overrides:

equals in class Object

Parameters:

obj - Other object

Returns:

True if equal

hashCode

public int hashCode()

Get hash code for Option.

Overrides:

hashCode in class Object

Returns:

Hash code

clone

public Object clone()

Return deep copy of this option object

Specified by:

clone in interface LanguageObject

Overrides:

clone in class Object

Returns:

Deep copy of the object