org.cip4.jdflib.datatypes

Class JDFShapeRangeList

java.lang.Object

org.cip4.jdflib.datatypes.JDFRangeList

org.cip4.jdflib.datatypes.JDFShapeRangeList

All Implemented Interfaces:

JDFBaseDataTypes

public class JDFShapeRangeList
extends JDFRangeList

Author:

Rainer Prosi, Heidelberger Druckmaschinen *

Nested Class Summary

Nested classes/interfaces inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes

JDFBaseDataTypes.EnumFitsValue

Field Summary

Fields inherited from class org.cip4.jdflib.datatypes.JDFRangeList

rangeList

Fields inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes

EPSILON, MAX_CMYK_COLOR, MAX_LAB_COLOR, MAX_MATRIX_DIMENSION, MAX_RECTANGLE_DIMENSION, MAX_RGB_COLOR, MAX_SHAPE_DIMENSION, MAX_XY_DIMENSION

Constructor Summary

Constructors

Constructor and Description
JDFShapeRangeList() empty constructor
JDFShapeRangeList(JDFShapeRangeList rl) copy constructor constructs a JDFShapeRangeList with the given JDFShapeRangeList
JDFShapeRangeList(String s) constructs a JDFShapeRangeList from the values of a given String

Method Summary

Methods

Modifier and Type	Method and Description
void	append(JDFShape x) append - adds an individual JDFShape element
void	append(JDFShape xMin, JDFShape xMax) append - adds an element defined by two JDFShapes: xMin~xMax
void	append(JDFShapeRange x) append - adds an element defined by a JDFShapeRange
static JDFShapeRangeList	createShapeRangeList(String s) factory for JDFShapeRangeList that silently returns null in case of illegal strings
boolean	inRange(JDFShape x) inRange - check whether shape 'x' is in the shape range defined by 'this'
boolean	isOrdered() isOrdered - tests if 'this' is OrderedRangeList
boolean	isUniqueOrdered() isUniqueOrdered - tests if 'this' is UniqueOrdered RangeList
boolean	isValid(String s) isValid - validate the given String
void	setString(String s) setString - deserialize a string Reads the string, which represents JDFShapeRangeList, and converts it into real JDFShapeRangeList

Methods inherited from class org.cip4.jdflib.datatypes.JDFRangeList

at, begin, clear, elementAt, end, equals, erase, getString, getString, hashCode, isList, isPartOfRange, isPartOfRange, isUnique, remove, size, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JDFShapeRangeList

public JDFShapeRangeList()

empty constructor

JDFShapeRangeList

public JDFShapeRangeList(JDFShapeRangeList rl)

copy constructor
constructs a JDFShapeRangeList with the given JDFShapeRangeList

Parameters:

rl -

JDFShapeRangeList

public JDFShapeRangeList(String s)
                  throws DataFormatException

constructs a JDFShapeRangeList from the values of a given String

Parameters:

s - the given String

Throws:

DataFormatException - - if the String has not a valid format

Method Detail

createShapeRangeList

public static JDFShapeRangeList createShapeRangeList(String s)

factory for JDFShapeRangeList that silently returns null in case of illegal strings

Parameters:

s - the string to parse

Returns:

the JDFShapeRangeList, null if s is not compatible

inRange

public boolean inRange(JDFShape x)

inRange - check whether shape 'x' is in the shape range defined by 'this'

Parameters:

x - shape value to test

Returns:

boolean - true if 'x' is in the range defined by 'this'

setString

public void setString(String s)
               throws DataFormatException

setString - deserialize a string Reads the string, which represents JDFShapeRangeList, and converts it into real JDFShapeRangeList

Parameters:

s - string to read

Throws:

DataFormatException - - if the String has not a valid format

isValid

public boolean isValid(String s)

isValid - validate the given String

Parameters:

s - the given string

Returns:

boolean - false if the String has not a valid format

append

public void append(JDFShapeRange x)

append - adds an element defined by a JDFShapeRange

Parameters:

x - the range to append to the list

append

public void append(JDFShape x)

append - adds an individual JDFShape element

Parameters:

x - the left and right value of the range to append to the list

append

public void append(JDFShape xMin,
          JDFShape xMax)

append - adds an element defined by two JDFShapes: xMin~xMax

Parameters:

xMin - the left value of the range to append to the list

xMax - the right value of the range to append to the list

isOrdered

public boolean isOrdered()

isOrdered - tests if 'this' is OrderedRangeList

Specified by:

isOrdered in class JDFRangeList

Returns:

boolean - true if 'this' is a OrdneredRangeList

isUniqueOrdered

public boolean isUniqueOrdered()

isUniqueOrdered - tests if 'this' is UniqueOrdered RangeList

Specified by:

isUniqueOrdered in class JDFRangeList

Returns:

boolean - true if 'this' is UniqueOrdered RangeList