cox.jmatt.java.MathTools.graphing
Enum Constraint.Requirement

java.lang.Object
  extended by java.lang.Enum<Constraint.Requirement>
      extended by cox.jmatt.java.MathTools.graphing.Constraint.Requirement
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Constraint.Requirement>
Enclosing class:
Constraint

public static enum Constraint.Requirement
extends java.lang.Enum<Constraint.Requirement>

This enum is provided as a switch()-able way to designate specific conditions and their targeted value. The only value associated with any Requirement is its String designation. Where not stated, the designation matches Java syntax. E.g. EQUAL is '=='.

The intent behind this enum is to provide a 'human-readable' indication of what conditions and constraints should be present when graphing. The second concern is a switch()-able way to express or generate piecewise functions or similar constructs.


Enum Constant Summary
AND
           
COMPLEX
          String designation is '(C)' .
EMPTY
          String designation is: '{}' .
EQUAL
           
EXIST
          String designation is: '!{}' .
GREATER_OR_EQUAL
           
GREATER_THAN
           
INFINITY
          String designation is: '<-->'.
INTEGER
          String designation is '(Z)' .
INTERVAL
          String designation is '[]' (square brackets).
LESS_OR_EQUAL
           
LESS_THAN
           
MAXIMUM
          String designation is 'max' (lower case).
MINIMUM
          String designation is 'min' (lower case) .
NATURAL
          String designation is '(N)' .
NEGATIVE
          String designation is: '<0' .
NEGATIVE_INFINITY
          String designation is: '<--'.
NOT
           
NOT_EQUAL
           
OR
           
POSITIVE
          String designation is '>0'.
POSITIVE_INFINITY
          String designation is: '-->'.
RATIONAL
          String designation is '(Q)' .
REAL
          String designation is '(R)' .
TEXT
          String designation is '$' (dollar sign).
UNKNOWN
          String designation is: ??.
WHOLE
          String designation is '(W)' .
 
Method Summary
 java.lang.String designation()
          Retrieve the symbol associated with this Condition.
 boolean matches(java.lang.String pDesignation)
          Determine whether or not the given String matches this Condition.
static Constraint.Requirement valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Constraint.Requirement[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

UNKNOWN

public static final Constraint.Requirement UNKNOWN
String designation is: ??.


LESS_THAN

public static final Constraint.Requirement LESS_THAN

LESS_OR_EQUAL

public static final Constraint.Requirement LESS_OR_EQUAL

GREATER_THAN

public static final Constraint.Requirement GREATER_THAN

GREATER_OR_EQUAL

public static final Constraint.Requirement GREATER_OR_EQUAL

NOT_EQUAL

public static final Constraint.Requirement NOT_EQUAL

EQUAL

public static final Constraint.Requirement EQUAL

AND

public static final Constraint.Requirement AND

OR

public static final Constraint.Requirement OR

NOT

public static final Constraint.Requirement NOT

INFINITY

public static final Constraint.Requirement INFINITY
String designation is: '<-->'.


NEGATIVE_INFINITY

public static final Constraint.Requirement NEGATIVE_INFINITY
String designation is: '<--'.


POSITIVE_INFINITY

public static final Constraint.Requirement POSITIVE_INFINITY
String designation is: '-->'.


POSITIVE

public static final Constraint.Requirement POSITIVE
String designation is '>0'.


NEGATIVE

public static final Constraint.Requirement NEGATIVE
String designation is: '<0' .


EXIST

public static final Constraint.Requirement EXIST
String designation is: '!{}' . This constraint can also be interpreted as 'non-empty' or 'defined'.


EMPTY

public static final Constraint.Requirement EMPTY
String designation is: '{}' . This can also be interpreted as 'does not exist' or 'undefined'.


MINIMUM

public static final Constraint.Requirement MINIMUM
String designation is 'min' (lower case) .


MAXIMUM

public static final Constraint.Requirement MAXIMUM
String designation is 'max' (lower case).


INTERVAL

public static final Constraint.Requirement INTERVAL
String designation is '[]' (square brackets).


TEXT

public static final Constraint.Requirement TEXT
String designation is '$' (dollar sign).


COMPLEX

public static final Constraint.Requirement COMPLEX
String designation is '(C)' .


REAL

public static final Constraint.Requirement REAL
String designation is '(R)' .


RATIONAL

public static final Constraint.Requirement RATIONAL
String designation is '(Q)' .


INTEGER

public static final Constraint.Requirement INTEGER
String designation is '(Z)' .


WHOLE

public static final Constraint.Requirement WHOLE
String designation is '(W)' .


NATURAL

public static final Constraint.Requirement NATURAL
String designation is '(N)' .

Method Detail

values

public static Constraint.Requirement[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (Constraint.Requirement c : Constraint.Requirement.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Constraint.Requirement valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

matches

public boolean matches(java.lang.String pDesignation)
Determine whether or not the given String matches this Condition.


designation

public java.lang.String designation()
Retrieve the symbol associated with this Condition.