org.jaffa.metadata
Class DateTimeFieldMetaData

java.lang.Object
  org.jaffa.metadata.FieldMetaData
      org.jaffa.metadata.DateTimeFieldMetaData

All Implemented Interfaces:

Cloneable, Comparable, Serializable

public class DateTimeFieldMetaData

extends FieldMetaData

An instance of this class will hold meta information for a DateTime field.

See Also:

Serialized Form

Field Summary

static int

DEFAULT_WIDTH Default width.

Fields inherited from class org.jaffa.metadata.FieldMetaData

LOWER_CASE, MIXED_CASE, UPPER_CASE

Constructor Summary

DateTimeFieldMetaData()
Creates an instance.

DateTimeFieldMetaData(String name, String labelToken, Boolean isMandatory, String layout, DateTime minValue, DateTime maxValue)
Creates an instance.

Method Summary

Object	clone() Returns a clone of the object.
int	compareTo(Object obj) Compares this object with another DateTimeFieldMetaData object.
boolean	equals(Object obj) Compares this object with another DateTimeFieldMetaData object.
static String	getDateTimeFormat()
static String[]	getDateTimeParse()
String	getLayout() Getter for property layout.
DateTime	getMaxValue() Getter for property maxValue.
DateTime	getMinValue() Getter for property minValue.
int	getWidth() Getter for property width.
int	hashCode() Returns the hash code.
DateOnlyFieldMetaData	toDateOnlyFieldMetaData() Returns an equivalent DateOnlyFieldMetaData object.
String	toString() Returns the diagnostic information.

Methods inherited from class org.jaffa.metadata.FieldMetaData

getDataType, getLabelToken, getName, isMandatory

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default width.

See Also:

Constant Field Values

Constructor Detail

DateTimeFieldMetaData

public DateTimeFieldMetaData()

Creates an instance.

DateTimeFieldMetaData

public DateTimeFieldMetaData(String name,
                             String labelToken,
                             Boolean isMandatory,
                             String layout,
                             DateTime minValue,
                             DateTime maxValue)

Creates an instance.

Parameters:

name - The field name.

labelToken - The token used for displaying labels.

isMandatory - Indicates if the field is mandatory.

layout - The layout.

minValue - The minimum value.

maxValue - The maximum value.

Method Detail

getLayout

public String getLayout()

Getter for property layout.

Returns:

Value of property layout.

getMinValue

public DateTime getMinValue()

Getter for property minValue.

Returns:

Value of property minValue.

getMaxValue

public DateTime getMaxValue()

Getter for property maxValue.

Returns:

Value of property maxValue.

clone

public Object clone()

Returns a clone of the object.

Overrides:

clone in class FieldMetaData

Returns:

a clone of the object.

hashCode

public int hashCode()

Returns the hash code.

Overrides:

hashCode in class FieldMetaData

Returns:

the hash code.

equals

public boolean equals(Object obj)

Compares this object with another DateTimeFieldMetaData object. Returns a true if both the objects have the same properties.

Overrides:

equals in class FieldMetaData

Parameters:

obj - the other DateTimeFieldMetaData object.

Returns:

a true if both the objects have the same properties.

compareTo

public int compareTo(Object obj)

Compares this object with another DateTimeFieldMetaData object. Note: this class has a natural ordering that is inconsistent with equals

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class FieldMetaData

Parameters:

obj - the other DateTimeFieldMetaData object.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

toString

public String toString()

Returns the diagnostic information.

Overrides:

toString in class FieldMetaData

Returns:

the diagnostic information.

getWidth

public int getWidth()

Getter for property width.

Specified by:

getWidth in class FieldMetaData

Returns:

Value of property width.

toDateOnlyFieldMetaData

public DateOnlyFieldMetaData toDateOnlyFieldMetaData()

Returns an equivalent DateOnlyFieldMetaData object.

Returns:

an equivalent DateOnlyFieldMetaData object.

getDateTimeParse

public static String[] getDateTimeParse()

getDateTimeFormat

public static String getDateTimeFormat()