|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectbiz.c24.io.api.data.DataType
biz.c24.io.api.data.ComplexDataType
public class ComplexDataType
A data type constructed from other data types.
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.
ComplexDataObject
,
Serialized FormField Summary |
---|
Fields inherited from class biz.c24.io.api.data.DataType |
---|
duringParsing, hasEnumerations, hasPatternMatching, qualifierValidation |
Constructor Summary | |
---|---|
ComplexDataType()
Constructs a new instance. |
Method Summary | |
---|---|
void |
addAttrDecl(Attribute attr)
Adds a attribute declaration to the structure of this object. |
void |
addElementDecl(Element element)
Adds an element declaration. |
void |
addIdGeneratorParameter(IDGeneratorParameter parameter)
Adds and IDGeneratorParameter to the list. |
boolean |
containsAttrDecl(String name)
Returns whether this type contains a attribute called name . |
boolean |
containsElementDecl(String name)
Returns whether this type contains an element declaration called name
|
protected Object |
createObject(DataComponent definingDataComponentDecl)
|
AlignToBorder |
getAlignToBorder()
|
Attribute |
getAttrDecl(int index)
Returns the attribute declaration at index . |
Attribute |
getAttrDecl(String name)
Returns the attribute declaration called name . |
int |
getAttrDeclCount()
Returns the total number of attribute present in this types structure. |
int |
getAttrDeclIndex(Attribute attr)
Returns the index of attribute . |
ComplexDataType |
getBaseType()
Returns the base type. |
BitMap |
getBitMap()
|
TypeBlockEnum |
getBlock()
Returns the block value. |
String |
getChildSequenceColumnName()
Returns the name of the child, that represents the column in a database, that will be used to store the order of the children. |
ContentModelEnum |
getContentModel()
Returns the content model. |
SimpleDataType |
getContentType()
Returns the content type. |
String[] |
getDelimiter()
Returns the delimiter(s). |
String[] |
getDelimiterFieldWrapper()
Returns the delimiter field wrapper(s). |
DelimiterLocationEnum |
getDelimiterLocation()
Returns the location of the delimiter. |
Element |
getElementDecl(int index)
Returns the element declaration at index . |
Element |
getElementDecl(String name)
Returns the element declaration called name . |
int |
getElementDeclCount()
Returns the total number of elements present in this types structure. |
int |
getElementDeclIndex(Element element)
Returns the index of an element declaration. |
FinalEnum |
getFinal()
Returns the final value. |
FormatTypeEnum |
getFormatType()
Returns the format type. |
IDGeneratorMethodEnum |
getIdGenerator()
returns the Hibernate Id generator method to be used. |
int |
getIdGeneratorParameterIndex(IDGeneratorParameter parameter)
Returns the location of the specified IDGeneratorParameter , of where it will appear when applied to the
Id Generator. |
IDGeneratorParameter[] |
getIdGeneratorParameters()
Returns all the Id Generator parameters as an array of IDGeneratorParameter . |
Attribute |
getNativeAttrDecl(int index)
Return the native attribute declaration at index . |
int |
getNativeAttrDeclCount()
Returns the number of native attributes (i.e. not inherited from the base type). |
int |
getNativeAttrDeclIndex(Attribute attr)
Returns the index of native attribute declaration. |
Element |
getNativeElementDecl(int index)
Returns the native element at index . |
int |
getNativeElementDeclCount()
Returns the number of elements native to this type (i.e. not inherited from the base type). |
int |
getNativeElementDeclIndex(Element element)
Returns the index of a native element declaration. |
ComplexDataType |
getOrderingType()
Returns the ordering type. |
Class |
getValidObjectClass()
Returns the class of valid objects of this type. |
boolean |
isAbstract()
Returns whether this type is abstract. |
boolean |
isAttributeGroup()
Returns whether this type is an attribute group. |
boolean |
isCollated()
Returns whether this type is collated. |
boolean |
isComplex()
Returns whether this type is complex. |
boolean |
isDelimiterPlaceholder()
Returns whether the delimiter uses placeholders. |
boolean |
isElementGroup()
Returns whether this type is an element group. |
boolean |
isExcludeFromDatabase()
Returns whether this object should be excluded from database persistence. |
boolean |
isExtension()
Returns whether this type has a base type and if so whether it is an extension of it. |
boolean |
isMixed()
Returns whether this type is mixed. |
boolean |
isProcessAsBatch()
Gets whether this type should be processsed as a batch. |
boolean |
isRestriction()
Returns whether this type has a base type and if so whether it is a restriction of it. |
boolean |
isSimple()
Returns whether this type is simple. |
boolean |
isUrType()
Sets whether this type represents a UR-type. |
Element |
lookupExpectedElement(InputStream stream,
Element docRoot,
ComplexDataType docRootType)
Expected element discovery callback. |
void |
removeAttrDecl(Attribute attr)
Removes the attribute declaration. |
void |
removeAttrDecl(int index)
Removes the attribute declaration at index i . |
void |
removeElementDecl(Element element)
Removes an element declaration. |
void |
removeElementDecl(int index)
Removes the element declaration at index i . |
void |
removeIdGeneratorParameter(IDGeneratorParameter parameter)
Removes the specified parameter. |
void |
setAbstract(boolean abstracT)
Sets whether this type is abstract. |
void |
setAlignToBorder(AlignToBorder alignToBorder)
|
void |
setAttributeGroup(boolean attributeGroup)
Sets whether this type is an attribute group. |
void |
setBaseType(ComplexDataType baseType)
Sets the base type. |
void |
setBitMap(BitMap bitMap)
|
void |
setBlock(TypeBlockEnum block)
Sets the block value. |
void |
setChildSequenceColumnName(String childSequenceColumnName)
Sets the name of the child, that represents the column in a database, that will be used to store the order of the children. |
void |
setCollated(boolean collated)
Sets whether this field would like its subfields collated. |
void |
setContentModel(ContentModelEnum contentModel)
Sets the content model. |
void |
setContentType(SimpleDataType contentType)
Sets the content type. |
void |
setDelimiter(String[] delimiter)
Sets the delimiter(s). |
void |
setDelimiterFieldWrapper(String[] delimiterFieldWrapper)
Sets the delimiter field wrapper(s). |
void |
setDelimiterLocation(DelimiterLocationEnum delimiterLocation)
Sets the delimiter's location. |
void |
setDelimiterPlaceholder(boolean delimiterPlaceholder)
Sets the delimiter's status as a placeholder or not. |
void |
setElementGroup(boolean elementGroup)
Sets whether this type is an element group. |
void |
setExcludeFromDatabase(boolean excludeFromDatabase)
Sets whether this object should be excluded from database persistence. |
void |
setExtension(boolean extension)
Sets whether this type is an extension. |
void |
setFinal(FinalEnum finaL)
Sets the final value. |
void |
setFormatType(FormatTypeEnum formatType)
Sets the format type. |
void |
setIdGenerator(IDGeneratorMethodEnum idGenerator)
sets the Hibernate ID generation method to be used. |
void |
setIdGeneratorParameterAt(IDGeneratorParameter parameter,
int index)
Sets the parameter at a specified index. |
void |
setMixed(boolean mixed)
Sets whether this type is mixed. |
void |
setOrderingType(ComplexDataType orderingType)
Sets the ordering type. |
void |
setProcessAsBatch(boolean processAsBatch)
Sets whether this type should be processed as a batch. |
void |
setRestriction(boolean restriction)
Sets whether this type is a restriction. |
void |
setUrType(boolean urType)
Sets whether this is a UR-type. |
void |
setValidObjectClass(Class validObjectClass)
Sets the valid object class. |
boolean |
validateProperties(Object object,
DataComponent comp,
ComplexDataObject context,
ValidationManager manager)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ComplexDataType()
Method Detail |
---|
public boolean isComplex()
DataType
isComplex
in class DataType
public boolean isSimple()
DataType
true
from this method if it is derived from a simple type.
isSimple
in class DataType
protected Object createObject(DataComponent definingDataComponentDecl)
public Class getValidObjectClass()
DataType
getValidObjectClass
in class DataType
public void setValidObjectClass(Class validObjectClass)
validObjectClass
- The new value.public ComplexDataType getBaseType()
public void setBaseType(ComplexDataType baseType)
baseType
- The new base type.public FinalEnum getFinal()
public void setFinal(FinalEnum finaL)
finaL
- The new value.public TypeBlockEnum getBlock()
public void setBlock(TypeBlockEnum block)
block
- The new block value.public boolean isExtension()
public void setExtension(boolean extension)
extension
- The new value.public boolean isRestriction()
public void setRestriction(boolean restriction)
restriction
- The new value.public final ContentModelEnum getContentModel()
public void setContentModel(ContentModelEnum contentModel)
contentModel
- The content model.public ComplexDataType getOrderingType()
public void setOrderingType(ComplexDataType orderingType)
orderingType
- The ordering type.public boolean isCollated()
public void setCollated(boolean collated)
collated
- Whether to collate subfields.public boolean isAttributeGroup()
public void setAttributeGroup(boolean attributeGroup)
attributeGroup
- The new value.public boolean isElementGroup()
public void setElementGroup(boolean elementGroup)
elementGroup
- The new value.public boolean isAbstract()
public void setAbstract(boolean abstracT)
abstracT
- The new value.public boolean isMixed()
public void setMixed(boolean mixed)
mixed
- The new value.public FormatTypeEnum getFormatType()
public void setFormatType(FormatTypeEnum formatType)
formatType
- The format type.public String[] getDelimiter()
null
if no delimiters have been
specified.
null
is none have been specified.public void setDelimiter(String[] delimiter)
delimiter
- The delimiter(s).public DelimiterLocationEnum getDelimiterLocation()
public void setDelimiterLocation(DelimiterLocationEnum delimiterLocation)
delimiterLocation
- The delimiter's location.public boolean isDelimiterPlaceholder()
public void setDelimiterPlaceholder(boolean delimiterPlaceholder)
delimiterPlaceholder
- The new value.public String[] getDelimiterFieldWrapper()
null
if no delimiter wrappers have been
specified.
public void setDelimiterFieldWrapper(String[] delimiterFieldWrapper)
delimiterFieldWrapper
- The new value.public SimpleDataType getContentType()
public void setContentType(SimpleDataType contentType)
contentType
- The new content type.public boolean isExcludeFromDatabase()
public void setExcludeFromDatabase(boolean excludeFromDatabase)
excludeFromDatabase
- The new boolean value.public Element lookupExpectedElement(InputStream stream, Element docRoot, ComplexDataType docRootType) throws IOException
source
responsibility. To override this need to specify the
document root discriminator property in model.
stream
- The incoming data stream.docRoot
- The document root element instance.docRootType
- The type of the document root element instance.
IOException
- If unexpected I/O error happend.public void addElementDecl(Element element)
element
- The element.
IllegalArgumentException
- If an element declaration called name
has already been added.public void removeElementDecl(Element element)
element
- The element to be removed.public void removeElementDecl(int index)
i
.
index
- The index of the element declaration to be removedpublic int getNativeElementDeclCount()
public Element getNativeElementDecl(int index)
index
.
index
- The index of the element to return.
public int getNativeElementDeclIndex(Element element)
element
- The element.
public int getElementDeclCount()
public Element getElementDecl(int index)
index
.
index
- The index of the element to return.
public Element getElementDecl(String name)
name
.
name
- The name of the element to return.
IllegalArgumentException
- If the element could not be found.public boolean containsElementDecl(String name)
name
- Parameters:
name
- The name of the element.
- Returns:
- Whether an element called
name
is present.
public int getElementDeclIndex(Element element)
element
- The element.
public void addAttrDecl(Attribute attr)
attr
- The attribute.public void removeAttrDecl(Attribute attr)
attr
- The attribute declaration to be removed.public void removeAttrDecl(int index)
i
.
index
- The index of the attribute declaration to be removedpublic int getNativeAttrDeclCount()
public Attribute getNativeAttrDecl(int index)
index
.
index
- The index.
public int getNativeAttrDeclIndex(Attribute attr)
attr
- The attribute.
public int getAttrDeclCount()
public Attribute getAttrDecl(int index)
index
.
index
- The index.
public Attribute getAttrDecl(String name)
name
.
name
- The name of the attribute.
IllegalArgumentException
- If the attribute could not be found.public boolean containsAttrDecl(String name)
name
.
name
- The name of the attribute.
public int getAttrDeclIndex(Attribute attr)
attribute
.
attr
- The attribute.
public boolean validateProperties(Object object, DataComponent comp, ComplexDataObject context, ValidationManager manager) throws ValidationException
validateProperties
in class DataType
ValidationException
public IDGeneratorMethodEnum getIdGenerator()
public void setIdGenerator(IDGeneratorMethodEnum idGenerator)
idGenerator
- The Id Generator Method IDGeneratorMethodEnum
public String getChildSequenceColumnName()
public void setChildSequenceColumnName(String childSequenceColumnName)
childSequenceColumnName
- then name of the childpublic IDGeneratorParameter[] getIdGeneratorParameters()
IDGeneratorParameter
.
public void addIdGeneratorParameter(IDGeneratorParameter parameter)
parameter
- The IDGeneratorParameter containing the name and valuepublic int getIdGeneratorParameterIndex(IDGeneratorParameter parameter)
IDGeneratorParameter
, of where it will appear when applied to the
Id Generator.
parameter
- The parametmer to return the index of.
public void removeIdGeneratorParameter(IDGeneratorParameter parameter)
parameter
- The IDGeneratorParameter
to be removedpublic void setIdGeneratorParameterAt(IDGeneratorParameter parameter, int index)
parameter
- The new IDGeneratorParameter
index
- the indexpublic void setUrType(boolean urType)
urType
- Whether this is a UR-type.public boolean isUrType()
public final boolean isProcessAsBatch()
public void setProcessAsBatch(boolean processAsBatch)
processAsBatch
- Whether this should be processed as a batch.public BitMap getBitMap()
public void setBitMap(BitMap bitMap)
public AlignToBorder getAlignToBorder()
public void setAlignToBorder(AlignToBorder alignToBorder)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |