org.cip4.jdflib.datatypes

Class JDFDateTimeRangeList

java.lang.Object

org.cip4.jdflib.datatypes.JDFRangeList

org.cip4.jdflib.datatypes.JDFDateTimeRangeList

All Implemented Interfaces:

JDFBaseDataTypes

public class JDFDateTimeRangeList
extends JDFRangeList

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
JDFDateTimeRangeList() empty constructor
JDFDateTimeRangeList(JDFDateTimeRangeList rl) constructs a JDFDateTimeRangeList from the given JDFDateTimeRangeList
JDFDateTimeRangeList(java.lang.String s) constructs a JDFDateTimeRangeList from a given string

Method Summary

Modifier and Type	Method and Description
void	append(JDFDate x) Add an individual JDFDate element
void	append(JDFDate xMin, JDFDate xMax) Add a Duration range defined by two dates xMin~xMax
void	append(JDFDateTimeRange r) Add a Duration range r =rMin~rMax
static JDFDateTimeRangeList	createDateTimeRangeList(java.lang.String s) factory for JDFDateTimeRangeList that silently returns null in case of illegal strings
protected java.util.ArrayList<JDFDate>	getOrderedArray()
boolean	inRange(JDFDate x) inRange - returns true if the given JDFDate value is in one of the ranges of the range list
boolean	isOrdered() isOrdered - tests if 'this' is an OrderedRangeList
boolean	isUniqueOrdered() isUniqueOrdered - tests if 'this' is an UniqueOrdered RangeList
boolean	isValid(java.lang.String s) isValid - validate the given String
void	setString(java.lang.String s) setString - parse the given string and set the duration range list

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

JDFDateTimeRangeList

public JDFDateTimeRangeList()

empty constructor

JDFDateTimeRangeList

public JDFDateTimeRangeList(java.lang.String s)
                     throws java.util.zip.DataFormatException

constructs a JDFDateTimeRangeList from a given string

Parameters:

s - the given string

Throws:

java.util.zip.DataFormatException - - if the String has not a valid format

JDFDateTimeRangeList

public JDFDateTimeRangeList(JDFDateTimeRangeList rl)

constructs a JDFDateTimeRangeList from the given JDFDateTimeRangeList

Parameters:

rl - the given JDFDateTimeRangeList

Method Detail

createDateTimeRangeList

public static JDFDateTimeRangeList createDateTimeRangeList(java.lang.String s)

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

Parameters:

s - the string to parse

Returns:

the JDFDateTimeRangeList, null if s is not compatible

inRange

public boolean inRange(JDFDate x)

inRange - returns true if the given JDFDate value is in one of the ranges of the range list

Parameters:

x - the given JDFDate (duration) value to compare

Returns:

boolean - true if in range otherwise false

setString

public void setString(java.lang.String s)
               throws java.util.zip.DataFormatException

setString - parse the given string and set the duration range list

Parameters:

s - the given string

Throws:

java.util.zip.DataFormatException - - if the String has not a valid format

isValid

public boolean isValid(java.lang.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(JDFDateTimeRange r)

Add a Duration range r =rMin~rMax

Parameters:

r - the Duration range to append to the list

append

public void append(JDFDate xMin,
                   JDFDate xMax)

Add a Duration range defined by two dates xMin~xMax

Parameters:

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

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

append

public void append(JDFDate x)

Add an individual JDFDate element

Parameters:

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

isOrdered

public boolean isOrdered()

isOrdered - tests if 'this' is an OrderedRangeList

Specified by:

isOrdered in class JDFRangeList

Returns:

boolean - true if 'this' is an OrdneredRangeList

getOrderedArray

protected java.util.ArrayList<JDFDate> getOrderedArray()

isUniqueOrdered

public boolean isUniqueOrdered()

isUniqueOrdered - tests if 'this' is an UniqueOrdered RangeList

Specified by:

isUniqueOrdered in class JDFRangeList

Returns:

boolean - true if 'this' is an UniqueOrdered RangeList