|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.FormatElement
com.ibm.btt.base.FieldFormat
com.ibm.btt.base.TimeFormat
This class formats a Date as a String conforming to its attributes.
Field Summary |
---|
Fields inherited from class com.ibm.btt.base.FormatElement |
---|
dataElementName, externalizer, name |
Constructor Summary | |
---|---|
TimeFormat()
This is the default constructor used to create a TimeFormat object. |
|
TimeFormat(java.lang.String aName)
This is the constructor used by the externalizer to create a TimeFormat object. |
Method Summary | |
---|---|
java.lang.String[] |
extract(java.lang.String aString)
Extracts a String whose length is the expected length. |
java.lang.String |
formatField(DataField aDataField)
Formats a Date using the java.text.SimpleDatFormat class initialized with its parameters. |
protected java.lang.String[] |
getAmPmStrings()
Returns an array containing the am and pm String for the formatter. |
java.lang.String |
getAMString()
Returns the value of amString. |
boolean |
getHours24()
Returns true if the formatter formats according to a 24 hour clock, or false if it formats according to a 12 hour clock. |
protected java.lang.String |
getPattern()
Returns the pattern used when initializing the SimpleDateFormat. |
java.lang.String |
getPMString()
Returns the value of pmString. |
java.lang.String |
getSeparator()
Returns the value of separator. |
boolean |
getShowSeconds()
Returns true if the formatted String shows the seconds, or false if it does not. |
boolean |
getUseSeparator()
Returns the value of the useSeparator attribute. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes a TimeFormat with the aTag attributes. |
void |
setAMString(java.lang.String aString)
Sets the value of the amString. |
void |
setHours24(boolean b)
Sets the hours24 attribute. |
void |
setPMString(java.lang.String aString)
Sets the value of the pmString. |
void |
setSeparator(java.lang.String aString)
Sets the String used as the separator. |
void |
setShowSeconds(boolean aBoolean)
Sets the value of the showSeconds attribute. |
void |
setUseSeparator(boolean aBoolean)
Sets the value of the useSeparator attribute. |
java.lang.String |
toString()
Returns a visual representation of this format. |
DataField |
unformatField(java.lang.String aString,
DataField aDataField)
Unformats a String using the java.text.SimpleDatFormat class initialized with the declared parameters. |
Methods inherited from class com.ibm.btt.base.FieldFormat |
---|
format, format, toStrings, unformat, unformat |
Methods inherited from class com.ibm.btt.base.FormatElement |
---|
exceptionInfo, externalizer, getDataElementName, getExternalizer, getName, getTagName, isCacheable, isConstant, isItConstant, readExternal, readExternal, readObject, reinitialize, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toTags, writeExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public TimeFormat()
public TimeFormat(java.lang.String aName) throws java.io.IOException
aName
- java.lang.StringMethod Detail |
public java.lang.String[] extract(java.lang.String aString)
extract
in class FormatElement
aString
- String
public java.lang.String formatField(DataField aDataField) throws DSEInvalidClassException
formatField
in class FieldFormat
aDataField
- DataField
DSEInvalidClassException
protected java.lang.String[] getAmPmStrings()
public java.lang.String getAMString()
public boolean getHours24()
protected java.lang.String getPattern()
public java.lang.String getPMString()
public java.lang.String getSeparator()
public boolean getShowSeconds()
public boolean getUseSeparator()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException
initializeFrom
in interface Externalizable
initializeFrom
in class FormatElement
aTag
- com.ibm.btt.base.Tag
java.io.IOException
public void setAMString(java.lang.String aString)
aString
- java.lang.Stringpublic void setHours24(boolean b)
b
- booleanpublic void setPMString(java.lang.String aString)
aString
- java.lang.Stringpublic void setSeparator(java.lang.String aString)
aString
- java.lang.Stringpublic void setShowSeconds(boolean aBoolean)
aBoolean
- booleanpublic void setUseSeparator(boolean aBoolean)
aBoolean
- booleanpublic java.lang.String toString()
toString
in class FormatElement
public DataField unformatField(java.lang.String aString, DataField aDataField) throws DSEInvalidArgumentException
unformatField
in class FieldFormat
aString
- java.lang.StringaDataField
- DataField
DSEInvalidArgumentException
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |