Package org.cip4.jdflib.datatypes

Class JDFDateTimeRange

java.lang.Object

org.cip4.jdflib.datatypes.JDFRange

org.cip4.jdflib.datatypes.JDFDateTimeRange

All Implemented Interfaces:

JDFBaseDataTypes

public class JDFDateTimeRange
extends JDFRange

Nested Class Summary

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

JDFBaseDataTypes.EnumFitsValue

Field Summary

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	Description
JDFDateTimeRange()	Empty range constructor
JDFDateTimeRange(java.lang.String s)	Construct a JDFDateTimeRange from a string
JDFDateTimeRange(JDFDateTimeRange r)	copy constructor
JDFDateTimeRange(JDFDate x)	Constructor - creates a DateTime range defined by x ("from x to x")
JDFDateTimeRange(JDFDate xmin, JDFDate xmax)	Constructor - creates a DateTime range defined by xmin and xmax

Method Summary

Modifier and Type	Method	Description
static JDFDateTimeRange	createDateTimeRange(java.lang.String date)	factory style constructor that catches all exceptions and returns null if date is invalid
JDFDate	getLeft()	getLeft - get the left of the two range deliminators xmin ~ xmax
protected JDFDate	getLeftObject()
java.lang.String	getLeftString(int precision)
JDFDate	getLowerValue()	getLowerValue - returns the lower value of the bounds
JDFDate	getRight()	getRight - get the right of the two range deliminators xmin ~ xmax
protected JDFDate	getRightObject()
java.lang.String	getRightString(int precision)
JDFDate	getUpperValue()	getUpperValue - returns the upper value of the bounds
java.lang.String	getXJDFString(int precision)	toString
protected void	init(JDFDate xmin, JDFDate xmax)	Initialization
protected boolean	inObjectRange(java.lang.Object other)
boolean	inRange(JDFDate x)	inRange - returns true if 'x' is within the range defined by 'this'
boolean	isPartOfRange(JDFRange ra)	isPartOfRange - is range 'r' within this range?
boolean	isValid(java.lang.String s)	isValid - validate the given String
void	setLeft(JDFDate x)	setLeft - sets the left JDFDate object of the range
void	setRight(JDFDate x)	setRight - sets the right JDFDate object of the range
java.lang.String	toString()	toString

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

equals, getString, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

JDFDateTimeRange

public JDFDateTimeRange()

Empty range constructor

JDFDateTimeRange

public JDFDateTimeRange(JDFDate x)

Constructor - creates a DateTime range defined by x ("from x to x")

Parameters:

x - boundary of the date/time range

JDFDateTimeRange

public JDFDateTimeRange(JDFDate xmin,
                        JDFDate xmax)

Constructor - creates a DateTime range defined by xmin and xmax

Parameters:

xmin -

xmax -

JDFDateTimeRange

public JDFDateTimeRange(JDFDateTimeRange r)

copy constructor

Parameters:

r -

JDFDateTimeRange

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

Construct a JDFDateTimeRange from a string

Parameters:

s -

Throws:

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

Method Detail

init

protected void init(JDFDate xmin,
                    JDFDate xmax)

Initialization

Parameters:

xmin -

xmax -

createDateTimeRange

public static JDFDateTimeRange createDateTimeRange(java.lang.String date)

factory style constructor that catches all exceptions and returns null if date is invalid

Parameters:

date - the formatted date string

Returns:

the JDFDate , null if date is not a valid string

toString

public java.lang.String toString()

toString

Overrides:

toString in class JDFRange

Returns:

String

getXJDFString

public java.lang.String getXJDFString(int precision)

toString

Overrides:

getXJDFString in class JDFRange

Returns:

String

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

inRange

public boolean inRange(JDFDate x)

inRange - returns true if 'x' is within the range defined by 'this'

Parameters:

x - JDFDate that is to be compared with 'this'

Returns:

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

isPartOfRange

public boolean isPartOfRange(JDFRange ra)

isPartOfRange - is range 'r' within this range?

Specified by:

isPartOfRange in class JDFRange

Parameters:

ra - the range to test

Returns:

boolean - true if range 'r' is within this range, else false

getLeft

public JDFDate getLeft()

getLeft - get the left of the two range deliminators xmin ~ xmax

Returns:

JDFDate - the left value

getRight

public JDFDate getRight()

getRight - get the right of the two range deliminators xmin ~ xmax

Returns:

JDFDate - the right value

setLeft

public void setLeft(JDFDate x)

setLeft - sets the left JDFDate object of the range

Parameters:

x - the left JDFDate object of the range

setRight

public void setRight(JDFDate x)

setRight - sets the right JDFDate object of the range

Parameters:

x - the right JDFDate object of the range

getUpperValue

public JDFDate getUpperValue()

getUpperValue - returns the upper value of the bounds

Returns:

JDFDate - the upper value of the range

getLowerValue

public JDFDate getLowerValue()

getLowerValue - returns the lower value of the bounds

Returns:

JDFDate - the lower value of the range

getRightObject

protected JDFDate getRightObject()

Specified by:

getRightObject in class JDFRange

getLeftObject

protected JDFDate getLeftObject()

Specified by:

getLeftObject in class JDFRange

inObjectRange

protected boolean inObjectRange(java.lang.Object other)

Overrides:

inObjectRange in class JDFRange

getRightString

public java.lang.String getRightString(int precision)

Overrides:

getRightString in class JDFRange

getLeftString

public java.lang.String getLeftString(int precision)

Overrides:

getLeftString in class JDFRange