com.ibm.dse.appl.ej.base
Class DateConverterDefinition

java.lang.Object
  |
  +--com.ibm.dse.base.DataElement
        |
        +--com.ibm.dse.appl.ej.base.ConverterDefinition
              |
              +--com.ibm.dse.appl.ej.base.DateConverterDefinition

public class DateConverterDefinition
extends ConverterDefinition

DateConverterDefintion is the class for all elements that externally define CBTF DateConverters components as DataElements. The value of these definitions is an instance of the com.ibm.dse.gui.DateConverter class.

See Also:
Serialized Form

Field Summary
protected static java.lang.String DEFAULT_ERROR
           
protected static boolean DEFAULT_FOURDIGITS
           
protected static int DEFAULT_ORDERING
           
protected static java.lang.String DEFAULT_PATTERN
           
protected static java.lang.String DEFAULT_SEPARATOR
           
protected static boolean DEFAULT_USESEP
           
protected  java.lang.String ERROR
           
protected  java.lang.String errorMessage
           
protected  java.lang.String FALSE
           
protected  java.lang.String FOURDIGITS
           
protected  boolean fourDigitYear
           
protected  int ordering
           
protected  java.lang.String ORDERING
           
protected  java.lang.String pattern
           
protected  java.lang.String PATTERN
           
protected  java.lang.String separator
           
protected  java.lang.String SEPARATOR
           
protected  java.lang.String TRUE
           
protected  boolean useSep
           
protected  java.lang.String USESEP
           
 
Fields inherited from class com.ibm.dse.appl.ej.base.ConverterDefinition
value
 
Fields inherited from class com.ibm.dse.base.DataElement
description, name, state
 
Constructor Summary
DateConverterDefinition()
          This constructor creates a DateConverterDefintion object.
 
Method Summary
 java.lang.Object clone()
          Required because of superclass.
 java.lang.String getErrorMessage()
          Returns the value of the errorMessage property.
 int getOrdering()
          Returns the value of the ordering property.
 java.lang.String getPattern()
          Returns the value of the pattern property.
 java.lang.String getSeparator()
          Returns the value of the separator property.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a DateConverterDefinition object with the aTag attributes.
 boolean isFourDigitYear()
          Returns the value of the fourDigitYear property.
 boolean isUseSep()
          Returns the value of the useSep property.
 void setErrorMessage(java.lang.String newErrorMessage)
          Sets the value of the errorMessage property.
 void setFourDigitYear(boolean newFourDigitYear)
          Sets the value of the fourDigitYear property.
 void setOrdering(int newOrdering)
          Sets the value of the ordering property.
 void setPattern(java.lang.String newPattern)
          Sets the value of the pattern property.
 void setSeparator(java.lang.String newSeparator)
          Sets the value of the separator property.
 void setUseSep(boolean newUseSep)
          Sets the value of the useSep property.
 void setValue(java.lang.Object newValue)
          If newValue is an instance of DateConverter, sets the value of the value property.
 java.lang.String toString()
          Returns an SGML representation of this DateConverterDefinition Object.
 java.lang.Object validate(java.lang.Object anObject)
          Required by the superclass
 
Methods inherited from class com.ibm.dse.appl.ej.base.ConverterDefinition
getValue, nestedElements, nestedElements, nestedFields
 
Methods inherited from class com.ibm.dse.base.DataElement
externalizer, getDescription, getDescriptor, getElementAt, getErrorInfo, getExternalizer, getKey, getName, getState, getTagName, readExternal, readExternal, readObject, removeElementAt, removeExternal, setDescription, setDescriptor, setErrorInfo, setExternalizer, setName, setState, toStrings, toTags, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

pattern

protected java.lang.String pattern

errorMessage

protected java.lang.String errorMessage

fourDigitYear

protected boolean fourDigitYear

ordering

protected int ordering

separator

protected java.lang.String separator

useSep

protected boolean useSep

PATTERN

protected final java.lang.String PATTERN

ERROR

protected final java.lang.String ERROR

USESEP

protected final java.lang.String USESEP

ORDERING

protected final java.lang.String ORDERING

FOURDIGITS

protected final java.lang.String FOURDIGITS

SEPARATOR

protected final java.lang.String SEPARATOR

TRUE

protected final java.lang.String TRUE

FALSE

protected final java.lang.String FALSE

DEFAULT_PATTERN

protected static final java.lang.String DEFAULT_PATTERN

DEFAULT_ERROR

protected static final java.lang.String DEFAULT_ERROR

DEFAULT_FOURDIGITS

protected static final boolean DEFAULT_FOURDIGITS

DEFAULT_ORDERING

protected static final int DEFAULT_ORDERING

DEFAULT_SEPARATOR

protected static final java.lang.String DEFAULT_SEPARATOR

DEFAULT_USESEP

protected static final boolean DEFAULT_USESEP
Constructor Detail

DateConverterDefinition

public DateConverterDefinition()
This constructor creates a DateConverterDefintion object.
Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Required because of superclass.
Overrides:
clone in class DataElement
Returns:
java.lang.Object
Throws:
java.lang.CloneNotSupportedException - The exception description.

getErrorMessage

public java.lang.String getErrorMessage()
Returns the value of the errorMessage property.
Returns:
java.lang.String - The current value of errorMessage.

getOrdering

public int getOrdering()
Returns the value of the ordering property.
Returns:
int - The current value of ordering.

getPattern

public java.lang.String getPattern()
Returns the value of the pattern property.
Returns:
java.lang.String - The current value of pattern.

getSeparator

public java.lang.String getSeparator()
Returns the value of the separator property.
Returns:
java.lang.String - The current value of separator.

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Initializes a DateConverterDefinition object with the aTag attributes.
Overrides:
initializeFrom in class ConverterDefinition
Parameters:
aTag - com.ibm.dse.base.Tag Contains the name and attributes of the object to be created.
Returns:
Object - An instance of DateConverterDefinition.
Throws:
java.io.IOException - The object can not be created.

isFourDigitYear

public boolean isFourDigitYear()
Returns the value of the fourDigitYear property.
Returns:
boolean - The current value of fourDigitYear.

isUseSep

public boolean isUseSep()
Returns the value of the useSep property.
Returns:
boolean - The current value of useSep.

setErrorMessage

public void setErrorMessage(java.lang.String newErrorMessage)
Sets the value of the errorMessage property.
Parameters:
newErrorMessage - java.lang.String The new value of the property.

setFourDigitYear

public void setFourDigitYear(boolean newFourDigitYear)
Sets the value of the fourDigitYear property.
Parameters:
newFourDigitYear - boolean The new value of the property.

setOrdering

public void setOrdering(int newOrdering)
Sets the value of the ordering property.
Parameters:
newOrdering - int The new value of the property.

setPattern

public void setPattern(java.lang.String newPattern)
Sets the value of the pattern property.
Parameters:
newPattern - java.lang.String The new value of the property.

setSeparator

public void setSeparator(java.lang.String newSeparator)
Sets the value of the separator property.
Parameters:
newSeparator - java.lang.String The new value of the property.

setUseSep

public void setUseSep(boolean newUseSep)
Sets the value of the useSep property.
Parameters:
newUseSep - boolean The new value of the property.

setValue

public void setValue(java.lang.Object newValue)
              throws DSEInvalidArgumentException
If newValue is an instance of DateConverter, sets the value of the value property.
Overrides:
setValue in class ConverterDefinition
Parameters:
newValue - java.lang.Object The new value of the property.
Throws:
DSEInvalidArgumentException - - The parameter is not a DateConverter Object.

toString

public java.lang.String toString()
Returns an SGML representation of this DateConverterDefinition Object.
Overrides:
toString in class java.lang.Object
Returns:
java.lang.String

validate

public java.lang.Object validate(java.lang.Object anObject)
                          throws DSETypeException
Required by the superclass
Overrides:
validate in class DataElement
Parameters:
anObject - java.lang.Object
Returns:
java.lang.Object
Throws:
DSETypeException -