Class ListReturningStatsOperator

java.lang.Object

com.github.gbenroscience.parser.Operator

com.github.gbenroscience.parser.ListReturningStatsOperator

All Implemented Interfaces:

Validatable

public final class ListReturningStatsOperator
extends Operator
implements Validatable

Author:

GBEMIRO

Field Summary

Fields inherited from class com.github.gbenroscience.parser.Operator

AND, ASSIGN, AT, CLOSE_CIRC_BRAC, CLOSE_SQUARE_BRAC, COLON, COMBINATION, COMMA, CONST, CUBE, CUBE_ROOT, DIVIDE, EN_DASH, EQUALS, EXIT, FACTORIAL, GREATER_OR_EQUALS, GREATER_THAN, INVERSE, LESS_OR_EQUALS, LESS_THAN, MINUS, MULTIPLY, name, OPEN_CIRC_BRAC, OPEN_SQUARE_BRAC, operators, OR, PERMUTATION, PLUS, POWER, REMAINDER, ROOT, SEMI_COLON, SPACE, SQUARE, STORE

Constructor Summary

Constructors

Constructor	Description
ListReturningStatsOperator(String op, int index, ArrayList<String> scan)

Method Summary

Modifier and Type	Method	Description
Bracket	getCloseBracket()
static String	getErrorMessage()
int	getIndex()
Bracket	getOpenBracket()
ListReturningStatsOperator	getParent()
boolean	hasParent(ArrayList<String> scan)
boolean	isSuperParent()
void	setCloseBracket(Bracket closeBracket)
static void	setErrorMessage(String errorMessage)
void	setIndex(int index)
void	setOpenBracket(Bracket openBracket)
void	setParent(ListReturningStatsOperator parent)	The concept of a parent here is that the first ListReturningStatsOperator object to this Operator's left is one that encloses it.
void	setSuperParent(boolean superParent)
String	toString()
boolean	validate(ArrayList<String> scan)
static boolean	validateFunction(ArrayList<String> scan)	Takes an object of class Function and validates its ListReturningStatsOperators objects.

Methods inherited from class com.github.gbenroscience.parser.Operator

getName, getPrecedence, isAssignmentOperator, isAtOperator, isBinaryOperator, isBracket, isClosingBrace, isClosingBracket, isColon, isComma, isConstantStoreCommand, isCube, isCubeRoot, isEqualsOperator, isExitCommand, isFactorial, isGreaterOrEqualsOperator, isGreaterThanOperator, isInverse, isLessThanOperator, isLessThanOrEqualsOperator, isLogicOperator, isMulOrDiv, isMulOrDivOrRemOrPermOrCombOrPow, isOpeningBrace, isOpeningBracket, isOperatorString, isPermOrComb, isPlusOrMinus, isPower, isRemainder, isSemiColon, isSquare, isSquareRoot, isStoreCommand, isUnaryPostOperator, isUnaryPreOperator, setName, validateAll

Methods inherited from class java.lang.Object

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

Constructor Details

ListReturningStatsOperator

public ListReturningStatsOperator(String op,
 int index,
 ArrayList<String> scan)

Parameters:

op - the name of the operator

index - the index of this Operator in its parent scanned function.

scan - the ArrayList object that contains the scanned function that has this ListReturningStatsOperator object

Method Details

setOpenBracket

public void setOpenBracket(Bracket openBracket)

Parameters:

openBracket - sets the opening bracket for this Operator

getOpenBracket

public Bracket getOpenBracket()

Returns:

the opening bracket for this Operator

setCloseBracket

public void setCloseBracket(Bracket closeBracket)

Parameters:

closeBracket - sets the closing bracket for this Operator

getCloseBracket

public Bracket getCloseBracket()

Returns:

the closing bracket for this Operator

setIndex

public void setIndex(int index)

Parameters:

index - sets the location of this Operator object in its parent scanned function.

getIndex

public int getIndex()

Returns:

the index of its parent scanned function.

setSuperParent

public void setSuperParent(boolean superParent)

Parameters:

superParent - sets whether or not this is the container ListReturningStatsOperator object for the data set.

isSuperParent

public boolean isSuperParent()

Returns:

true if this is the container ListReturningStatsOperator object for the data set.

setParent

public void setParent(ListReturningStatsOperator parent)

The concept of a parent here is that the first ListReturningStatsOperator object to this Operator's left is one that encloses it. i.e sort(2,3,mode(4,1,1,3)) Here sort is a parent to mode. But in sort(2,3,sort(4,1,3,4),mode(4,5,1)),mode will have no parent here by our definition. The outermost sort which would have been its parent does not immediately enclose it.The outermost sort however is a parent to the second sort(4,1,3,4). We use this special definition for parent because we wish to ensure that each object of this class will validate its own surroundings, not even its contents. It will not validate beyond the next ListReturningStatsOperator to it.

Parameters:

parent - sets the ListReturningStatsOperator object that immediately envelopes this one.

getParent

public ListReturningStatsOperator getParent()

Returns:

the ListReturningStatsOperator object that immediately envelopes this one.

setErrorMessage

public static void setErrorMessage(String errorMessage)

Parameters:

errorMessage - sets the error message generated by objects of this class.

getErrorMessage

public static String getErrorMessage()

Returns:

the error message generated by objects of this class.

hasParent

public boolean hasParent(ArrayList<String> scan)

Parameters:

scan - the ArrayList containing the scanned function

Returns:

true if the first ListReturningStatsOperator object to its left is its parent. So it can have a parent and yet return false here.

validate

public boolean validate(ArrayList<String> scan)

Specified by:

validate in interface Validatable

Parameters:

scan - the ArrayList of the scanned function that contains this object

Returns:

true if this object scans through its surroundings to the left and to the right and sees a valid bracket structure around itself

validateFunction

public static boolean validateFunction(ArrayList<String> scan)

Takes an object of class Function and validates its ListReturningStatsOperators objects.

Parameters:

scan - the scanner output

Returns:

true if valid

toString

public String toString()

Overrides:

toString in class Object