Skip navigation links

com.essbase.eas.ui.editor.misc
Interface StatementToken

All Known Implementing Classes:

StatementCommand

public interface StatementToken

Title: Description: Copyright: Copyright (c) 2001 Company: Hyperion Solutions Corporation

Version:

1.0

Author:

Sree Menon

Method Summary

void	addCommand(StatementToken command) adds next set of token commands
void	addCommandOptions(java.util.List list) This will add any options the command has
void	addOptions(StatementContext context) adds the options available for this command token
void	canceledCommand(TextEditor editor, int startoffset) invoked when the user cancels a command;
java.lang.String	getAttribute(java.lang.Object key) gets the attribute
java.lang.String	getEndOfStatement() Returns the string that represents the end of statement
StatementToken	getLastStatementToken(StatementContext context, int startindex) getLastStatementToken is a forward traversal of the list looking for the last token
java.lang.String	getName() Returns the name of the Token
java.lang.Object	getParent()
boolean	hasKey(java.lang.Object key)
int	isCommand(StatementContext context) Given a token list, returns whether it represent the command 0 means its not and any other number means the number of tokens that make up the command
boolean	isLastToken() Returns true if its the last token of the command syntax
boolean	isOptional() returns true, if this command is an optional one
int	isToken(StatementContext context, int startindex) Returns the number of tokens matched by this command from the token list
void	put(java.lang.Object key, java.lang.Object value) puts an attribute
void	resetParent() Walks the children and reset their parent to be this
void	setCompleteText(StatementContext context, int startoffset) sets the completed word into the editor
void	setCompleteText(TextEditor editor, int startoffset)
void	setCompleteText(TextEditor editor, java.lang.String text, int startoffset) sets the completed word into the editor
void	setOptions(StatementContext context) Returns a list of options for a given command token
void	setParent(java.lang.Object parent) sets the token command's parent
void	setWordCompleteText(TextEditor editor, java.lang.String text, int startoffset)
void	showOptions(StatementContext context) Shows the options
java.lang.String	toString() gets the display string

Method Detail

getName

java.lang.String getName()

Returns the name of the Token

Returns:

the name of the command

getLastStatementToken

StatementToken getLastStatementToken(StatementContext context,
                                     int startindex)

getLastStatementToken is a forward traversal of the list looking for the last token

Parameters:

tokenList - is the list containing the tokens that forms the current statement

startindex - is the token index to start processing the tokens from the list

Returns:

the last token

setOptions

void setOptions(StatementContext context)

Returns a list of options for a given command token

Parameters:

properties -

addOptions

void addOptions(StatementContext context)

adds the options available for this command token

Parameters:

context - statement context

toString

java.lang.String toString()

gets the display string

Overrides:

toString in class java.lang.Object

Returns:

string to display

isLastToken

boolean isLastToken()

Returns true if its the last token of the command syntax

getEndOfStatement

java.lang.String getEndOfStatement()

Returns the string that represents the end of statement

isToken

int isToken(StatementContext context,
            int startindex)

Returns the number of tokens matched by this command from the token list

setCompleteText

void setCompleteText(StatementContext context,
                     int startoffset)

sets the completed word into the editor

setCompleteText

void setCompleteText(TextEditor editor,
                     int startoffset)

setCompleteText

void setCompleteText(TextEditor editor,
                     java.lang.String text,
                     int startoffset)

sets the completed word into the editor

setWordCompleteText

void setWordCompleteText(TextEditor editor,
                         java.lang.String text,
                         int startoffset)

canceledCommand

void canceledCommand(TextEditor editor,
                     int startoffset)

invoked when the user cancels a command;

showOptions

void showOptions(StatementContext context)

Shows the options

isOptional

boolean isOptional()

returns true, if this command is an optional one

isCommand

int isCommand(StatementContext context)

Given a token list, returns whether it represent the command 0 means its not and any other number means the number of tokens that make up the command

put

void put(java.lang.Object key,
         java.lang.Object value)

puts an attribute

Parameters:

key - attribute key

value - attribute value

getAttribute

java.lang.String getAttribute(java.lang.Object key)

gets the attribute

Parameters:

key - attribute key

Returns:

the value, could be null

addCommand

void addCommand(StatementToken command)

adds next set of token commands

Parameters:

command - one of the next command that follows this

setParent

void setParent(java.lang.Object parent)

sets the token command's parent

Parameters:

parent - the parent

resetParent

void resetParent()

Walks the children and reset their parent to be this

getParent

java.lang.Object getParent()

addCommandOptions

void addCommandOptions(java.util.List list)

This will add any options the command has

Parameters:

list -

hasKey

boolean hasKey(java.lang.Object key)

Parameters:

key - usually a string object

Returns:

true if token has object set

Skip navigation links