All Packages  Class Hierarchy

Index of all Fields and Methods

A

add(String, Object, String, String). Static method in class designer.DBProxy

Method Name: add()
Purpose: This method will add a key,value pair into the database.

addConstraint(String). Method in class designer.Plan

Purpose: Creates new Constaint
Pre: none
Post: Constraint created, added to end of vector

addDesignPlan(Plan). Method in class designer.Specialist

Purpose: Creates new instance of a design selector, adds to end of vector
Pre: none
Post: selector created

addFinalConstraint(Constraint). Method in class designer.Specialist

Purpose: Adds a final constraint to the Specialist
Pre: none
Post: constraint added to end of vector

addInitialConstraint(Constraint). Method in class designer.Specialist

Purpose: Adds an initial constraint to the Specialist
Pre: none
Post: constraint added to start of vector

addItem(PlanItem). Method in class designer.Plan

Purpose: Adds a new item to the plan list
Pre: duplicate name should not exist
Post: item added to planlist

addLogicalOperation(LogicalOperation, int). Method in class designer.TableMatcher

This method will provide users with ways of adding (appending)
a boolean expression onto the table, at a particular row.

addRoughPlan(Plan). Method in class designer.Specialist

Purpose: Creates new instance of a rough plan, adds to end of vector
Pre: none
Post: selector created

addSpecialist(String). Method in class designer.Plan

Purpose: Creates a new Specialist
Pre: none
Post: Specialist created, added to end of vector

addStep(Step). Method in class designer.Task

Adds a step to the end of the stepList vector
PRE: stepToAdd is an Object that implements Step interface.

addTask(String). Method in class designer.Plan

Purpose: Creates a new Task and adds it to the end of the list
Pre: none
Post: Task created, added to end of vector

append(LogicalOperation). Method in class designer.LogicalOperation

Method Name: append
Purpose: This method is used to append two logical operations together.

Assignment(String). Constructor for class designer.Assignment

Method Name: Constructor
Purpose: Obvious.

C

Calculation(int). Constructor for class designer.Calculation

This is the constructor for the calculator.

check(boolean). Method in class designer.DesignByContract

Method Name: check
Purpose: This method is called when Java programmers wish to check
class variables and/or states.

Constraint(). Constructor for class designer.Constraint

Default Constructor

Constraint(String). Constructor for class designer.Constraint

Constructor with name

D

DBProxy(). Constructor for class designer.DBProxy

DesignByContract(). Constructor for class designer.DesignByContract

Class Constructor.

disable(). Method in class designer.DesignByContract

Method Name: disable
Purpose: This method is called to disable "Design By Contract".

E

elementType(String). Static method in class designer.DBProxy

Method Name: elementType
Purpose: This looks up the element's type.

enable(). Method in class designer.DesignByContract

Method Name: enable
Purpose: This method is called to enable "Design By Contract".

ensure(boolean). Method in class designer.DesignByContract

Method Name: ensure
Purpose: This method is called when Java programmers wish to check
outgoing return values and/or class states.

execute(). Method in class designer.Assignment

Method Name: execute() Purpose: This method will execute the assignment, even if it means executing
a calculation.

execute(). Method in class designer.Calculation

MethodName: execute()
Purpose: This method is called after the execution stack has been loaded.

execute(). Method in class designer.Constraint

perform the constraint check

PRE: _logicOp defined
POST: if successful return true

execute(). Method in class designer.IfThenElse

performs the logical operation then executes either the ifTask or the thenTask
PRE: _logicOp, _ifTask defined.

execute(). Method in class designer.LogicalOperation

Method Name: execute
Purpose: This method will execute this logical operation.

execute(). Method in class designer.Plan

Purpose: Executes all tasks, specialists and constraints in the list
Pre: none
Post: return true if all plan items executed correctly, else false

execute(). Method in class designer.Specialist

Pre: none
Post: all objects belonging to specialist are run

execute(). Method in class designer.Sponsor

Purpose: Runs the Sponsor
Pre: _tableMatcher must be assigned to a valid object or null
Post: Returns an integer value representing the suitability of the plan

execute(). Method in interface designer.Step

perform the main functionality of the step.

execute(). Method in class designer.TableMatcher

This method will execute the table matcher.

execute(). Method in class designer.Task

Execute each step in StepList in order

execute(Vector). Method in class designer.Selector

Purpose: Runs the selector class, calls all the plans in the plan list and
their associated sponsor to find the best plan.

executeStack(). Method in class designer.LogicalOperation

MethodName: executeStack()
Purpose: This method is called after the execution stack has been loaded.

G

get(Object). Static method in class designer.DBProxy

Method Name: get
Purpose: Retrieves the value of the passed key (or variable).

getDesignPlanAt(int). Method in class designer.Specialist

Purpose: Gets reference to an item in the vector
Pre: index <= vector.size() && index >= 0
Post: rtnval == Plan

getDisplayType(Object). Static method in class designer.DBProxy

Purpose: Returns the display type of the key passed
PRE: key is not null
POST: String representation of type returned

getExecutionResult(). Method in class designer.Calculation

MethodName: getExecutionResult()
Purpose: This method is called after the execution stack has been executed.

getExecutionResult(). Method in class designer.LogicalOperation

MethodName: getExecutionResult()
Purpose: This method is called after the execution stack has been executed.

getFinalConstAt(int). Method in class designer.Specialist

Purpose: Gets reference to an item in the vector
Pre: index <= vector.size() >= 0
Post: rtnval == Constraint

getInitConstAt(int). Method in class designer.Specialist

Purpose: Gets reference to an item in the vector
Pre: index <= vector.size() && index >= 0
Post: rtnval == Constraint

getItemAt(int). Method in class designer.Plan

Purpose: Gets the individual plan items
Pre: index >= 0 && index < planList.size()
Post: rtnval == planItems

getName(). Method in class designer.Assignment

Method Name: getName()
Purpose: This method will return the class name to the caller.

getName(). Method in class designer.Constraint

getName(). Method in class designer.IfThenElse

getName(). Method in class designer.Plan

Purpose: Gets the name of the Plan
Pre: none
Post: returns name of selector

getName(). Method in class designer.Selector

Purpose: Gets the name of the Selector
Pre: none
Post: returns name of selector

getName(). Method in class designer.Specialist

Purpose: Returns name of Specialist
Pre: none
Post: returns name of Specialist

getName(). Method in class designer.Sponsor

Purpose: gets the name of the Sponsor
Pre: none Post: returns name of sponsor

getName(). Method in interface designer.Step

getName(). Method in class designer.Task

getNames(). Static method in class designer.DBProxy

Method Name: getNames
Purpose: Returns names of all variables in database
Pre: none
Post: names returned in Vector

getRank(). Method in class designer.Plan

Purpose: Runs the Sponsor to get the rank
Pre: none
Post: returns rank

getRoughPlanAt(int). Method in class designer.Specialist

Purpose: Gets reference to an item in the vector
Pre: index <= vector.size() >=0
Post: rtnval == Plan

getSponsor(). Method in class designer.Plan

Purpose: Gets the reference to the sponsor
Pre: none
POst: retval == Sponsor

getStepAt(int). Method in class designer.Task

PRE: index < stepList.length

getStepNames(). Method in class designer.Task

getTargetRow(). Method in class designer.TableMatcher

This method is used, in the event of a successful return value
from execute(), to retrieve the array position where success occurred.

I

IfThenElse(). Constructor for class designer.IfThenElse

Default constructor

IfThenElse(String). Constructor for class designer.IfThenElse

Constructor with name

insertDesignPlanAt(int, Plan). Method in class designer.Specialist

Purpose: Inserts existing plan at index
Pre: index <= Vector.size()
Post: Plan added to Vector

insertFinalConstraintAt(int, Constraint). Method in class designer.Specialist

Purpose: Inserts existing constraint at index
Pre: index <= Vector.size()
Post: Plan added to Vector

insertInitConstraintAt(int, Constraint). Method in class designer.Specialist

Purpose: Inserts existing constraint at index
Pre: index <= Vector.size()
Post: Plan added to Vector

insertItemAt(int, PlanItem). Method in class designer.Plan

Purpose: inserts the object into the vector
Pre: index <= Vector.size() && (newPlanItem must be type Task, Specialist or Constraint
Post: newPlanItem inserted at index

insertRoughPlanAt(int, Plan). Method in class designer.Specialist

Purpose: Inserts existing plan at index
Pre: index <= Vector.size()
Post: Plan added to Vector

insertStepAt(Step, int). Method in class designer.Task

Insert a step at the given index in stepList.

L

LogicalOperation(int). Constructor for class designer.LogicalOperation

This is the constructor for the logical operation.

lookupBoolean(String). Static method in class designer.DBProxy

Method Name: lookupBoolean
Purpose: Used for database entries that are booleans.

lookupNumber(String). Static method in class designer.DBProxy

Method Name: lookupNumber
Purpose: Used for database entries that are integers.

O

out. Static variable in class designer.Standard

P

Plan(). Constructor for class designer.Plan

Purpose: Default constructor

Plan(String). Constructor for class designer.Plan

Purpose: Constructor

pushOperand(boolean). Method in class designer.LogicalOperation

Method Name: pushOperand
Purpose: This method will push an integer operand onto the
execution stack.

pushOperand(Calculation). Method in class designer.Calculation

Method Name: pushOperand
Purpose: This method will push a calculation operand onto the
execution stack.

pushOperand(Calculation). Method in class designer.LogicalOperation

Method Name: pushOperand
Purpose: This method will push a Calculation operand onto the
execution stack.

pushOperand(double). Method in class designer.Calculation

Method Name: pushOperand
Purpose: This method will push a double operand onto the
execution stack.

pushOperand(double). Method in class designer.LogicalOperation

Method Name: pushOperand
Purpose: This method will push a double operand onto the
execution stack.

pushOperand(float). Method in class designer.Calculation

Method Name: pushOperand
Purpose: This method will push a float operand onto the
execution stack.

pushOperand(float). Method in class designer.LogicalOperation

Method Name: pushOperand
Purpose: This method will push a float operand onto the
execution stack.

pushOperand(int). Method in class designer.Calculation

Method Name: pushOperand
Purpose: This method will push an integer operand onto the
execution stack.

pushOperand(int). Method in class designer.LogicalOperation

Method Name: pushOperand
Purpose: This method will push an integer operand onto the
execution stack.

pushOperand(long). Method in class designer.Calculation

Method Name: pushOperand
Purpose: This method will push long integer operand onto the
execution stack.

pushOperand(long). Method in class designer.LogicalOperation

Method Name: pushOperand
Purpose: This method will push long integer operand onto the
execution stack.

pushOperand(String). Method in class designer.Calculation

Method Name: pushOperand
Purpose: This method will push a string operand onto the
execution stack.

pushOperand(String). Method in class designer.LogicalOperation

Method Name: pushOperand
Purpose: This method will push an integer operand onto the
execution stack.

pushOperator(String[]). Method in class designer.Calculation

Method Name: pushOperator
Purpose: This method will receive a String dictating the operator
to push on the stack.

pushOperator(String[]). Method in class designer.LogicalOperation

Method Name: pushOperator
Purpose: This method will receive a String dictating the operator
to push on the stack.

R

remove(Object). Static method in class designer.DBProxy

Method Name: remove
Purpose: Removes the variable from the database.

removeDesignPlan(String). Method in class designer.Specialist

remove a plan from the vector by its name
PRE: itemToRemoveName matchs name of an object in stepList
POST: vector does not include step with name itemToRemoveName

removeDesignPlanAt(int). Method in class designer.Specialist

remove a step from vector by its index
PRE: 0 <= index < stepList.length
POST: _designPlanList does not include step previously at index .

removeFinalConstraint(String). Method in class designer.Specialist

remove a constraint from the vector by its name
PRE: itemToRemoveName matchs name of an object in stepList
POST: vector does not include step with name itemToRemoveName

removeFinalConstraintAt(int). Method in class designer.Specialist

remove a constraint from vector by its index
PRE: 0 <= index < stepList.length
POST: _finalConsttList does not include step previously at index .

removeInitConstraint(String). Method in class designer.Specialist

remove a constraint from the vector by its name
PRE: itemToRemoveName matchs name of an object in stepList
POST: vector does not include step with name itemToRemoveName

removeInitConstraintAt(int). Method in class designer.Specialist

remove a constraint from vector by its index
PRE: 0 <= index < stepList.length
POST: _initConsttList does not include step previously at index .

removeItemAt(int). Method in class designer.Plan

remove a planItem from planList by its index
PRE: 0 <= index < stepList.length
POST: stepList does not include step previously at index .

removeOperand(). Method in class designer.Calculation

Method Name: removeOperand
Purpose: This method will remove the top-most operand from the
execution stack.

removeOperand(). Method in class designer.LogicalOperation

Method Name: removeOperand
Purpose: This method will remove the top-most operand from the
execution stack.

removeOperator(). Method in class designer.Calculation

Method Name: removeOperator
Purpose: This method will remove the top-most operator from the
execution stack.

removeOperator(). Method in class designer.LogicalOperation

Method Name: removeOperator
Purpose: This method will remove the top-most operator from the
execution stack.

removePlanItem(String). Method in class designer.Plan

remove a plan from the vector by its name
PRE: itemToRemoveName matchs name of an object in stepList
POST: vector does not include step with name itemToRemoveName

removeRoughPlan(String). Method in class designer.Specialist

remove a plan from the vector by its name
PRE: itemToRemoveName matchs name of an object in stepList
POST: vector does not include step with name itemToRemoveName

removeRoughPlanAt(int). Method in class designer.Specialist

remove a step from vector by its index
PRE: 0 <= index < stepList.length
POST: _roughPlanList does not include step previously at index .

removeStep(String). Method in class designer.Task

remove a step from stepList by its name removes the first step with this name if more than one step has same name.

removeStepAt(int). Method in class designer.Task

remove a step from stepList by its index
PRE: 0 <= index < stepList.length
POST: stepList does not include step previously at index .

removeTableMatcher(). Method in class designer.Sponsor

Purpose: Removes the table matcher reference variable
Pre: none
Post: _tableMatch = null

removeTopMostElement(). Method in class designer.Calculation

Method Name: removeTopMostElement
Purpose: This method will remove the top-most element, regardless if it is
an operand or operator.

removeTopMostElement(). Method in class designer.LogicalOperation

Method Name: removeTopMostElement
Purpose: This method will remove the top-most element, regardless if it is
an operand or operator.

require(boolean). Method in class designer.DesignByContract

Method Name: require
Purpose: This method is called when Java programmers wish to check
incoming parameters and/or class states.

S

Selector(String). Constructor for class designer.Selector

Purpose: Constructor
Pre: none

setFalseResult(int, int). Method in class designer.TableMatcher

setFinalConstList(Vector). Method in class designer.Specialist

Purpose: Set the final constraint list to the passed list
Pre: none
Post: Constraint List set

setFinePlanList(Vector). Method in class designer.Specialist

Purpose: Set the Final plan list to the passed list
Pre: none
Post: Final plan List set

setFineSelector(Selector). Method in class designer.Specialist

Purpose: Set the Final Selector to the passed list
Pre: none
Post: Final Selector set

setIfTask(Task). Method in class designer.IfThenElse

set _ifTask to reference passed in.

setInitConstList(Vector). Method in class designer.Specialist

Purpose: Set the constraint list to the passed list
Pre: none
Post: Constraint List set

setLogicOp(LogicalOperation). Method in class designer.Constraint

set the logical operation to be performed when this constraint is executed.

setLogicOp(LogicalOperation). Method in class designer.IfThenElse

set logicOp to reference passed in.

setName(String). Method in class designer.Task

sets the name parameter of this object to the String input.

setOut(PrintStream). Static method in class designer.Standard

setPlanItemList(Vector). Method in class designer.Plan

Purpose: Sets the plan list to an input vector of plan items
Pre: vector must contain all elements of PlanItem type
Post plan list set

setResult(int, int). Method in class designer.TableMatcher

This method allow setting of the result value for a particular row
PRE: rowNumber >= 0 && rowNumber < _trueResult.size();
POST: none

setResult(String). Method in class designer.Assignment

Method Name: setResult()
Purpose: Sets the result, or DB variable to assign (right hand side).

setRoughPlanList(Vector). Method in class designer.Specialist

Purpose: Set the rough plan list to the passed list
Pre: none
Post: Rough plan List set

setRoughSelector(Selector). Method in class designer.Specialist

Purpose: Set the Rough Selelctor to the passed list
Pre: none
Post: Rough Selector set

setSponsor(Sponsor). Method in class designer.Plan

Purpose: Sets the sponsor reference to a sponsor object
Pre: none
Post: sponsor reference set

setTableMatcher(TableMatcher). Method in class designer.Sponsor

Purpose: Sets the table matcher reference variable
Pre: none
Post: none

setThenTask(Task). Method in class designer.IfThenElse

set _thenTask to reference passed in.

setValue(Calculation). Method in class designer.Assignment

Method name: setValue()
Purpose: Sets the right hand of the assignment.

setValue(LogicalOperation). Method in class designer.Assignment

Method name: setValue()
Purpose: Sets the right hand of the assignment.

setValue(Number). Method in class designer.Assignment

Method name: setValue()
Purpose: Sets the right hand of the assignment.

setValue(String). Method in class designer.Assignment

Method name: setValue()
Purpose: Sets the right hand of the assignment.

Specialist(String). Constructor for class designer.Specialist

Purpose: Constructor
Pre: none
Post: Specialist initialized

Sponsor(String). Constructor for class designer.Sponsor

Purpose: Constructor

Standard(). Constructor for class designer.Standard

T

TableMatcher(int, int). Constructor for class designer.TableMatcher

This is the first constructor of the TableMatcher class.

Task(). Constructor for class designer.Task

Default construtor

Task(String). Constructor for class designer.Task

Construtor with name returns an instance of this class with the _name set to name.

U

updateValue(String, Object). Static method in class designer.DBProxy

Method Name: updateValue
Purpose: Places a new value in for the database variable.

V

validEntry(String). Static method in class designer.DBProxy

Method Name: validEntry
Purpose: Checks the database to see if dbEntry is an entry.

vSaveExecutionStack. Variable in class designer.LogicalOperation

This instance variable will hold the reference to a vector, which
in this case is the execution stack.