org.vishia.util

Class CalculatorExpr.Operand

java.lang.Object

org.vishia.util.CalculatorExpr.Operand

Direct Known Subclasses:

OutTextPreparer.Argument, OutTextPreparer.Cmd

Enclosing class:

CalculatorExpr

public static class CalculatorExpr.Operand
extends java.lang.Object

Operand for a part of the expression, refer from CalculatorExpr.Operation.

Field Summary

Fields

Modifier and Type	Field and Description
DataAccess	dataAccess Set if the value uses reflection.
java.lang.Object	dataConst Set for constant data.
CalculatorExpr	expr If not null the operand is calculated with an expression itself.
int	ixValue Index of the value contained in a given array on execution, -1 if not used.
java.lang.String	textOrVar The String literal or the given sDatapath.

Constructor Summary

Constructors

Constructor and Description
Operand(CalculatorExpr expr)
Operand(int ixValue, DataAccess dataAccess, java.lang.Object dataConst, java.lang.String textOrVar) Constructs
Operand(java.lang.Object value) Creates an operator which is a single data instance.
Operand(java.lang.String text) A ValueAccess without value, only a constant text literal, especially for Text Cmd.
Operand(java.lang.String sDatapath, java.util.Map<java.lang.String,DataAccess.IntegerIx> variables, java.lang.Class<?> reflData, java.util.Map<java.lang.String,java.lang.Object> idxConstData) Creates an Operand from the textual given datapath and the given enviromments.
Operand(StringPartScan sDatapath, java.util.Map<java.lang.String,DataAccess.IntegerIx> variables, java.lang.Class<?> reflData, boolean bSpecialSyntax) See Operand#Operand(StringPartScan, Map, Class, Map, boolean) but without the idxConstData
Operand(StringPartScan sDatapath, java.util.Map<java.lang.String,DataAccess.IntegerIx> variables, java.lang.Class<?> reflData, java.util.Map<java.lang.String,java.lang.Object> idxConstData, boolean bSpecialSyntax) See Operand#Operand(String, Map, Class, Map) but with StringPartScan for the sDatapath

Method Summary

Modifier and Type	Method and Description
java.lang.Object	calc(java.util.Map<java.lang.String,DataAccess.IntegerIx> nameVariables, java.lang.Object[] varValues) Accesses or calculates and returns the value of this operand.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ixValue

public int ixValue

Index of the value contained in a given array on execution, -1 if not used.

dataAccess

public final DataAccess dataAccess

Set if the value uses reflection.

dataConst

public final java.lang.Object dataConst

Set for constant data.

textOrVar

public final java.lang.String textOrVar

The String literal or the given sDatapath. Last one is for debug/comment, not for using.

expr

public final CalculatorExpr expr

If not null the operand is calculated with an expression itself.

Constructor Detail

Operand

public Operand(java.lang.String text)

A ValueAccess without value, only a constant text literal, especially for Text Cmd.

Parameters:

text -

Operand

public Operand(CalculatorExpr expr)

Operand

public Operand(int ixValue,
               DataAccess dataAccess,
               java.lang.Object dataConst,
               java.lang.String textOrVar)

Constructs

Parameters:

ixValue - -1 if no variable is used

dataAccess - maybe null, the access inside a given variable if ixValue >=0

dataConst -

textOrVar - Name of the variabe if ixValue >=0, constant text if ixValue <0

Operand

public Operand(java.lang.Object value)

Creates an operator which is a single data instance. Especially value can be an instanceof CalculatorExpr.Value, for numeric values. This is checked on evaluation of the data. Then numeric operations are possible. But value can be any Object, evaluated often with Object.toString() to get the string content or also evaluated with a DataAccess expression.

Parameters:

value -

Operand

public Operand(java.lang.String sDatapath,
               java.util.Map<java.lang.String,DataAccess.IntegerIx> variables,
               java.lang.Class<?> reflData,
               java.util.Map<java.lang.String,java.lang.Object> idxConstData)
        throws java.lang.Exception

Creates an Operand from the textual given datapath and the given enviromments.

• If idxConstData is given and the full sDatapath as key finds a content, this is stored in dataConst as value of the operand. All other are null.
• If the sDatapath describes a simple access to one of the variables, the index to the variables will be set to ixValue, the rest describes the access operation. expr as expression to execute is null.
• If sDatapath describes a more complex expression, then the parsed expression is stored in expr. The fields dataConst and dataAccess remains null.

Parameters:

sDatapath - textual given value. It is either a literal, a simple variable ...TODO docu

variables - Container with some variable names associated to indices in a value array.

reflData - type wich can contain a static member with the required name in sDatapath if the name is not found in variables

idxConstData - If this is not null, then it is first used to find dataConst with sDatapath as key.

Throws:

java.lang.Exception

Since:

2023-05 with givenData and as call of Operand#Operand(Object, StringPartScan, Map, Class, boolean)

Operand

public Operand(StringPartScan sDatapath,
               java.util.Map<java.lang.String,DataAccess.IntegerIx> variables,
               java.lang.Class<?> reflData,
               boolean bSpecialSyntax)
        throws java.text.ParseException

See Operand#Operand(StringPartScan, Map, Class, Map, boolean) but without the idxConstData

Parameters:

sDatapath -

variables - The variables will be completed by unknown but necessary variables. On execution then all variables are known.

reflData -

bSpecialSyntax -

Throws:

java.text.ParseException

Operand

public Operand(StringPartScan sDatapath,
               java.util.Map<java.lang.String,DataAccess.IntegerIx> variables,
               java.lang.Class<?> reflData,
               java.util.Map<java.lang.String,java.lang.Object> idxConstData,
               boolean bSpecialSyntax)
        throws java.text.ParseException

See Operand#Operand(String, Map, Class, Map) but with StringPartScan for the sDatapath

Parameters:

sDatapath -

variables - The variables will be completed by unknown but necessary variables. On execution then all variables are known.

reflData -

idxConstData -

bSpecialSyntax -

Throws:

java.text.ParseException

Method Detail

calc

public java.lang.Object calc(java.util.Map<java.lang.String,DataAccess.IntegerIx> nameVariables,
                             java.lang.Object[] varValues)
                      throws java.lang.Exception

Accesses or calculates and returns the value of this operand.

• The member ixValue addresses the possible value or start value for access.
• If ixValue is <0, then either or:
  • if dataConst is given, contains the value. If dataConst is instance of CalculatorExpr.Value, the stored value in CalculatorExpr.Value is used.
  • if expr is given, it is used to calculate the value, using the 'varValues' If the result is instanceof CalculatorExpr.Value, the stored value in CalculatorExpr.Value is used.
  • if dataAccess is given, calculates a static value (start with null as instance).
  • else it returns the given text in textOrVar
• If ixValue is >=0, the value is taken from the given 'varValues' with this index.
• If dataAccess is given, it accesses the data with the start path from dataConst, expr or just null (static data access).
• It means, it combines the given dataConst or the given expr with data Access, whereby combination with expr is only sensible if it returns an Object. This can be an array access expression or also a function call.
• If dataAccess is not given, the value, at least the textOrVar is returned.

Parameters:

nameVariables - see DataAccess.access(List, Object, boolean, boolean, Map, Object[], boolean, org.vishia.util.DataAccess.Dst) necessary on indirect access to variable via String, construct such as <&&(path)>

varValues - Array of possible values proper to the given ixValue

Returns:

if dataAccess is given, it accesses with the given start Object

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object