biz.c24.io.api.data
Class AtomicDataType

java.lang.Object
  extended by biz.c24.io.api.data.DataType
      extended by biz.c24.io.api.data.SimpleDataType
          extended by biz.c24.io.api.data.AtomicDataType
All Implemented Interfaces:
ModelComponent, Serializable
Direct Known Subclasses:
BinaryDataType, BooleanDataType, DateDataType, NumberDataType, StringDataType

public abstract class AtomicDataType
extends SimpleDataType

A simple type representing an atomic item of data. This abstract class acts as a marker in the class hierarchy.

Warning: Serialized objects of this class or of a deployed class which is derived from it may not be compatible with future releases of C24 Integreation Objects. The current serialization support is appropriate for short term storage or RMI between applications running the same version of C24 Integreation Objects.

See Also:
Serialized Form

Nested Class Summary
static class AtomicDataType.FinalEnum
          An enumeration of possible final values.
 
Field Summary
 
Fields inherited from class biz.c24.io.api.data.DataType
duringParsing, hasEnumerations, hasPatternMatching, qualifierValidation
 
Method Summary
 String formatObject(Object obj, boolean external)
          Formats the supplied obj into a string, possibly using the protected formatObjectExternal(Object) method.
abstract  String formatObjectOverride(Object obj)
           
 AtomicDataType.FinalEnum getFinal()
          Returns the final value.
 Locale getLocale()
          Returns the locale.
 String getPad()
          Returns the string used to pad the value to a size of getPadAmount().
 int getPadAmount()
          Returns the minimum length to which the value will be padded.
 PadJustificationEnum getPadJustification()
          Returns the pad justification.
 WhiteSpaceEnum getWhiteSpace()
          Returns the white space behaviour.
 Object parseObject(String str, boolean external)
          Parses the supplied str into an object, possibly using the protected parseObjectExternal(String, java.text.ParsePosition) method.
 void setFinal(AtomicDataType.FinalEnum finaL)
          Sets the final value.
 void setLocale(Locale locale)
          Sets the locale.
 void setPad(String pad)
          Sets the pad string.
 void setPadAmount(int padAmount)
          Sets the minimum length to which the value will be padded.
 void setPadJustification(PadJustificationEnum padJustification)
          Sets the pad justification.
 void setWhiteSpace(WhiteSpaceEnum whiteSpace)
          Sets the white space.
 
Methods inherited from class biz.c24.io.api.data.SimpleDataType
formatObject, formatObjectExternal, getInstance, getMaxExclusive, getMaxInclusive, getMaxSize, getMinExclusive, getMinInclusive, getMinSize, getValidObjectClass, isComplex, isSimple, isSizeFixed, parseObject, parseObjectExternal, setMaxExclusive, setMaxInclusive, setMinExclusive, setMinInclusive, validateProperties
 
Methods inherited from class biz.c24.io.api.data.DataType
addDerivedType, addValidator, addValidator, derivedTypeKeySet, getAnnotation, getDatabaseColumnName, getDerivedType, getDerivedType, getDerivedTypes, getDescription, getEnumeration, getInitiator, getModel, getName, getNullDefiningElementDecl, getOriginalName, getOriginalPatternMatch, getPatternMatch, getPatternType, getTerminator, getValidator, getValidatorCount, getValidatorIndex, hasDerivedTypes, isLocal, isValidObjectClass, removeDerivedType, removeValidator, setAnnotation, setDatabaseColumnName, setInitiator, setLocal, setModel, setName, setOriginalName, setOriginalPatternMatch, setPatternMatch, setPatternType, setTerminator, toString, validate, validateProperties, validateProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getFinal

public AtomicDataType.FinalEnum getFinal()
Returns the final value. The final value controls how this type can be derived.

Returns:
The final value.

setFinal

public void setFinal(AtomicDataType.FinalEnum finaL)
Sets the final value.

Parameters:
finaL - The new value.

getPad

public String getPad()
Returns the string used to pad the value to a size of getPadAmount().

Returns:
The pad string.

setPad

public void setPad(String pad)
Sets the pad string.

Parameters:
pad - The pad string.

getPadJustification

public PadJustificationEnum getPadJustification()
Returns the pad justification.

Returns:
The pad justification.

setPadJustification

public void setPadJustification(PadJustificationEnum padJustification)
Sets the pad justification.

Parameters:
padJustification - The pad justification.

getPadAmount

public int getPadAmount()
Returns the minimum length to which the value will be padded.

Returns:
The pad amount.

setPadAmount

public void setPadAmount(int padAmount)
Sets the minimum length to which the value will be padded.

Parameters:
padAmount - The pad amount.

getLocale

public Locale getLocale()
Returns the locale.

Returns:
The locale.

setLocale

public void setLocale(Locale locale)
Sets the locale.

Parameters:
locale - The locale.

getWhiteSpace

public WhiteSpaceEnum getWhiteSpace()
Returns the white space behaviour.

Returns:
The white space

setWhiteSpace

public void setWhiteSpace(WhiteSpaceEnum whiteSpace)
Sets the white space.

Parameters:
whiteSpace - The white space.

formatObject

public String formatObject(Object obj,
                           boolean external)
Description copied from class: SimpleDataType
Formats the supplied obj into a string, possibly using the protected formatObjectExternal(Object) method.

Overrides:
formatObject in class SimpleDataType
Parameters:
obj - The object to be formatted.
external - Whether the formatObjectExternal(Object) method should be used.
Returns:
The string.

formatObjectOverride

public abstract String formatObjectOverride(Object obj)

parseObject

public Object parseObject(String str,
                          boolean external)
                   throws ParserException
Description copied from class: SimpleDataType
Parses the supplied str into an object, possibly using the protected parseObjectExternal(String, java.text.ParsePosition) method.

Overrides:
parseObject in class SimpleDataType
Parameters:
str - The string to be parsed.
external - Whether the parseObjectExternal(String, java.text.ParsePosition) method should be used.
Returns:
The object.
Throws:
ParserException - If the parsing failed.


C24 Technologies © 2002-2012: All Rights Reserved.