[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

OperatorKind

Enum Class OperatorKind

java.lang.Object
java.lang.Enum<OperatorKind>
com.grapecity.documents.excel.expressions.OperatorKind
All Implemented Interfaces:
Serializable, Comparable<OperatorKind>, Constable
public enum OperatorKind extends Enum<OperatorKind>
Specifies the operator used in a formula syntax tree.

Use this enum with OperatorNode to represent arithmetic, comparison, reference, text-concatenation, and dynamic-array operators when building or inspecting parsed formulas.


 FormulaSyntaxTree syntaxTree = new FormulaSyntaxTree();
 OperatorNode rootNode = new OperatorNode(OperatorKind.Multiply);
 syntaxTree.setRoot(rootNode);

 Reference reference = new Reference();
 reference.setRow(0);
 reference.setColumn(0);
 reference.setLastRow(7);
 reference.setLastColumn(4);
 reference.setIsRowRelative(false);
 reference.setIsColumnRelative(true);
 reference.setIsLastRowRelative(false);
 reference.setIsLastColumnRelative(true);

 rootNode.getChildren().add(new ReferenceNode(reference));
 rootNode.getChildren().add(new NumberNode(9));

 UnParseContext context = new UnParseContext();
 context.setIsR1C1(true);
 String formulaText = syntaxTree.toString(context);

  • Enum Constant Details

    • Addition

      public static final OperatorKind Addition
      Represents the + operator.

      The + operator has the primary purpose of adding two numbers. This operator is defined only for double operands, and it always narrows its operands to double.

      Syntax:
      expression1 + expression2 or +expression2

      Parts:
      expression1: Optional. Any numeric or string expression.
      expression2: Required. Any numeric or string expression.

    • Subtraction

      public static final OperatorKind Subtraction
      Represents the - operator.

      Returns the difference between two numeric expressions or the negative value of a numeric expression.
      Syntax:
      expression1 - expression2 or -expression2
      Parts:
      expression1: Optional. Any numeric or string expression.
      expression2: Required. Any numeric or string expression.

    • Multiply

      public static final OperatorKind Multiply
      Represents the * operator.

      Multiplies two numeric expressions and returns their product.

      Syntax:
      expression1 * expression2

      Parts:
      expression1: Required. Any numeric or string expression.
      expression2: Required. Any numeric or string expression.

    • Division

      public static final OperatorKind Division
      Represents the / operator.

      Divides two numbers and returns a floating-point result, including any remainder.

      The QUOTIENT function returns the integer quotient and drops the remainder.

      Syntax:
      expression1 / expression2

      Parts:
      expression1: Required. Any numeric or string expression.
      expression2: Required. Any numeric or string expression.

    • Exponent

      public static final OperatorKind Exponent
      Represents the ^ operator.

      Raises a number to the power of another number, always as a double value.

      Syntax:
      number ^ exponent

      Parts:
      number: Required. Any numeric or string expression.
      exponent: Required. Any numeric or string expression.

    • Percentage

      public static final OperatorKind Percentage
      Represents the % operator.

      Divides a numeric expression by 100 and returns the result as a percentage value.
      Syntax:
      expression1%
      Parts:
      expression1: Required. Any numeric or string expression that can be converted to a number.

    • Concatenate

      public static final OperatorKind Concatenate
      Represents the &amp; operator.

      Concatenation operators join multiple strings into a single string. The &amp; operator is defined only for string operands, and it always widens its operands to string.

      Syntax:
      expression1 &amp; expression2

      Parts:
      expression1: Required. Any expression with a data type that widens to String.
      expression2: Required. Any expression with a data type that widens to String.

    • Range

      public static final OperatorKind Range
      Represents the : operator.

      The range operator returns a reference to all cells between the start and end reference cells, including both endpoints.
      Syntax:
      range1:range2
      Parts:
      range1: Required. Must be a range expression.
      range2: Required. Must be a range expression.

    • Union

      public static final OperatorKind Union
      Represents the , operator.

      The union operator combines two or more references into a single reference.

      Syntax:
      range1,range2
      Parts:
      range1: Required. Must be a range expression.
      range2: Required. Must be a range expression.

    • Intersection

      public static final OperatorKind Intersection
      Represents the (space) operator.

      The intersection operator gives a reference to the cells that are common to two range arguments.

      Syntax:
      range1 range2
      Parts:
      range1: Required. Must be a range expression.
      range2: Required. Must be a range expression.

    • Spill

      public static final OperatorKind Spill
      Represents the # operator.

      Refers to the entire spill range from the specified cell.
      Syntax:
      expression#
      Parts:
      expression: Required. Any cell reference expression.

    • Single

      public static final OperatorKind Single
      Represents the @ operator.
      Aggregates a range or array into a single value by using implicit intersection logic.
      Syntax:
      @expression
      Parts:
      expression: Required. Any range or function call expression.

    • Equality

      public static final OperatorKind Equality
      Represents the = operator.

      The equality operator compares two expressions to determine whether or not they are equal.

      Syntax:
      expression1 = expression2

      Parts:
      expression1: Required. Any expression.
      expression2: Required. Any expression.

    • Inequality

      public static final OperatorKind Inequality
      Represents the <> operator.

      The inequality operator compares two expressions to determine whether they are not equal.
      Syntax:
      expression1 &lt;&gt; expression2
      Parts:
      expression1: Required. Any expression.
      expression2: Required. Any expression.

    • LessThan

      public static final OperatorKind LessThan
      Represents the < operator.

      The less than operator compares two expressions to determine whether the left side is less than the right side.
      Syntax:
      expression1 &lt; expression2
      Parts:
      expression1: Required. Any expression.
      expression2: Required. Any expression.

    • LessThanOrEqual

      public static final OperatorKind LessThanOrEqual
      Represents the <= operator.

      The less than or equal operator compares two expressions to determine whether the left side is less than or equal to the right side.
      Syntax:
      expression1 &lt;= expression2
      Parts:
      expression1: Required. Any expression.
      expression2: Required. Any expression.

    • GreaterThan

      public static final OperatorKind GreaterThan
      Represents the > operator.

      The greater than operator compares two expressions to determine whether the left side is greater than the right side.
      Syntax:
      expression1 &gt; expression2
      Parts:
      expression1: Required. Any expression.
      expression2: Required. Any expression.

    • GreaterThanOrEqual

      public static final OperatorKind GreaterThanOrEqual
      Represents the >= operator.

      The greater than or equal operator compares two expressions to determine whether the left side is greater than or equal to the right side.
      Syntax:
      expression1 &gt;= expression2
      Parts:
      expression1: Required. Any expression.
      expression2: Required. Any expression.

  • Method Details

    • values

      public static OperatorKind[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OperatorKind valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Gets the numeric value of this enum member.
      Returns:
      The numeric value assigned to this operator kind.

    • forValue

      public static OperatorKind forValue(int value)
      Gets the enum member that corresponds to the specified numeric value.
      Parameters:
      value - The numeric value.
      Returns:
      The corresponding operator kind.