org.cip4.jdflib.core
Class JDFElement.EnumXYRelation

java.lang.Object
  org.apache.commons.lang.enums.Enum
      org.apache.commons.lang.enums.ValuedEnum
          org.cip4.jdflib.core.JDFElement.EnumXYRelation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Enclosing class:

JDFElement

public static final class JDFElement.EnumXYRelation
extends org.apache.commons.lang.enums.ValuedEnum

XYRelation Enumeration
XML attributes of type XYRelation define the relationship between two ordered numbers.
gt X>Y
ge X>=Y
eq X==Y
le X<=Y
lt X ne X!=Y
see JDF Spec (Appendix A.3.4) for latest changes

See Also:

Serialized Form

Field Summary

static JDFElement.EnumXYRelation	eq
static JDFElement.EnumXYRelation	ge
static JDFElement.EnumXYRelation	gt
static JDFElement.EnumXYRelation	le
static JDFElement.EnumXYRelation	lt
private static int	m_startValue
static JDFElement.EnumXYRelation	ne
private static long	serialVersionUID

Fields inherited from class org.apache.commons.lang.enums.Enum

iToString

Constructor Summary

private

JDFElement.EnumXYRelation(java.lang.String name)

Method Summary

boolean	evaluateXY(double x, double y, double nt, double pt) xyRelation - tests if relation x/y matches XYRelation enumeration value
static JDFElement.EnumXYRelation	getEnum(int enumValue)
static JDFElement.EnumXYRelation	getEnum(java.lang.String enumName)
static java.util.List	getEnumList()
static java.util.Map	getEnumMap()
static java.util.Iterator	iterator()

Methods inherited from class org.apache.commons.lang.enums.ValuedEnum

compareTo, getEnum, getValue, toString

Methods inherited from class org.apache.commons.lang.enums.Enum

equals, getEnum, getEnumClass, getEnumList, getEnumMap, getName, hashCode, iterator, readResolve

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

m_startValue

private static int m_startValue

gt

public static final JDFElement.EnumXYRelation gt

ge

public static final JDFElement.EnumXYRelation ge

eq

public static final JDFElement.EnumXYRelation eq

le

public static final JDFElement.EnumXYRelation le

lt

public static final JDFElement.EnumXYRelation lt

ne

public static final JDFElement.EnumXYRelation ne

Constructor Detail

JDFElement.EnumXYRelation

private JDFElement.EnumXYRelation(java.lang.String name)

Method Detail

getEnum

public static JDFElement.EnumXYRelation getEnum(java.lang.String enumName)

Parameters:

enumName - the name of the enum object to return

Returns:

the enum object if enumName is valid. Otherwise null

getEnum

public static JDFElement.EnumXYRelation getEnum(int enumValue)

Parameters:

enumValue - the value of the enum object to return

Returns:

the enum object if enumName is valid. Otherwise null

getEnumMap

public static java.util.Map getEnumMap()

Returns:

a map of all XYRelation enums

getEnumList

public static java.util.List getEnumList()

Returns:

a list of all XYRelation enums

iterator

public static java.util.Iterator iterator()

Returns:

an iterator over the enum objects

evaluateXY

public boolean evaluateXY(double x,
                          double y,
                          double nt,
                          double pt)

xyRelation - tests if relation x/y matches XYRelation enumeration value

Parameters:

x - x in XYRelation ( x/y )

y - y in XYRelation ( x/y )

nt - negative tolerance

pt - positive tolerance

Returns:

true, if relation x/y matches specified enumerated value