biz.c24.io.api.data
Class DataModel

java.lang.Object
  extended by biz.c24.io.api.data.DataModel
All Implemented Interfaces:
ModelComponent, Serializable

public class DataModel
extends Object
implements ModelComponent

A deployed data model, analagous to an XML schema.

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

Constructor Summary
DataModel()
          Constructs a new instance.
 
Method Summary
 Annotation getAnnotation()
          Returns the annotation associated with this type.
 FormEnum getAttributeFormDefault()
          Returns the attribute form default.
 ElementBlockEnum getBlockDefault()
          Retutns the block default.
static DataModel getBuiltInInstance()
          Returns a singleton instance.
 String getDescription()
          Returns a description of this type.
 FormEnum getElementFormDefault()
          Returns the element form default.
 FinalEnum getFinalDefault()
          Returns the final default.
 IDGeneratorMethodEnum getIdGeneratorMethodDefault()
          Retutns the ID generator default method.
 String getName()
          Returns the name of this component.
 ModelComponent getRedefined(ModelComponent redefiner)
          Returns the component that is redefined by redefiner.
 ModelComponent getRedefiner(ModelComponent redefined)
          Returns the component that redefines redefined.
 String getTargetNamespace()
          Returns the target namespace.
 String getUniqueID()
           
 String getUserVersion()
          Returns the user defined version.
 void putRedefine(ModelComponent redefined, ModelComponent redefiner)
          Adds a redefine from the original component, redefined, to the replacement component, redefiner.
 void removeRedefine(ModelComponent redefined)
          Removes the redefine for redefined.
 void setAnnotation(Annotation annotation)
          Sets the annotation.
 void setAttributeFormDefault(FormEnum attributeFormDefault)
          Sets the attribute for default.
 void setBlockDefault(ElementBlockEnum blockDefault)
          Sets teh block default.
 void setElementFormDefault(FormEnum elementFormDefault)
          Sets the element form default.
 void setFinalDefault(FinalEnum finalDefault)
          Sets the final default.
 void setIdGeneratorMethodDefault(IDGeneratorMethodEnum generatorMethodDefault)
          Sets the ID generator method default.
 void setName(String name)
          Sets the name.
 void setSink(Sink sink)
          Sets the default sink used by this model.
 void setSource(Source source)
          Sets the default source used by this model.
 void setTargetNamespace(String targetNamespace)
          Sets the target namespace.
 void setUniqueID(String uniqueID)
           
 void setUserVersion(String userVersion)
          Sets the user defined version.
 Sink sink()
          Returns a clone of the default sink used by this model.
 Source source()
          Returns a clone of the default source used by this model.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataModel

public DataModel()
Constructs a new instance.

Method Detail

getBuiltInInstance

public static DataModel getBuiltInInstance()
Returns a singleton instance.

Returns:
A singleton.

getName

public String getName()
Description copied from interface: ModelComponent
Returns the name of this component.

Specified by:
getName in interface ModelComponent
Returns:
The name.

setName

public void setName(String name)
Sets the name.

Parameters:
name - The new name.

getAnnotation

public Annotation getAnnotation()
Returns the annotation associated with this type.

Returns:
The annotation.

setAnnotation

public void setAnnotation(Annotation annotation)
Sets the annotation.

Parameters:
annotation - The annotation.

getDescription

public String getDescription()
Returns a description of this type. The description is taken from the annotation if one is present, otehrwise the empty string is returned.

Returns:
The description.

getTargetNamespace

public String getTargetNamespace()
Returns the target namespace.

Returns:
The target namesapce.

setTargetNamespace

public void setTargetNamespace(String targetNamespace)
Sets the target namespace.

If the empty string is used, it will be replaced by null.

Parameters:
targetNamespace - The new target namespace.

getUserVersion

public String getUserVersion()
Returns the user defined version.

Returns:
The user version.

setUserVersion

public void setUserVersion(String userVersion)
Sets the user defined version.

Parameters:
userVersion - The new user version.

getAttributeFormDefault

public FormEnum getAttributeFormDefault()
Returns the attribute form default. The attribute form default supplies the default value 'form' value for attributes.

Returns:
The attribute form default.

setAttributeFormDefault

public void setAttributeFormDefault(FormEnum attributeFormDefault)
Sets the attribute for default.

Parameters:
attributeFormDefault - The new value.

getElementFormDefault

public FormEnum getElementFormDefault()
Returns the element form default. The element form default supplies the default value 'form' value for elements.

Returns:
The element form default.

setElementFormDefault

public void setElementFormDefault(FormEnum elementFormDefault)
Sets the element form default.

Parameters:
elementFormDefault - The new value.

getFinalDefault

public FinalEnum getFinalDefault()
Returns the final default.

Returns:
The final defualt.

setFinalDefault

public void setFinalDefault(FinalEnum finalDefault)
Sets the final default.

Parameters:
finalDefault - The new final default.

getBlockDefault

public ElementBlockEnum getBlockDefault()
Retutns the block default.

Returns:
The block default.

setBlockDefault

public void setBlockDefault(ElementBlockEnum blockDefault)
Sets teh block default.

Parameters:
blockDefault - The new block default value.

getIdGeneratorMethodDefault

public IDGeneratorMethodEnum getIdGeneratorMethodDefault()
Retutns the ID generator default method.

Returns:
The generatorMethodDefault.

setIdGeneratorMethodDefault

public void setIdGeneratorMethodDefault(IDGeneratorMethodEnum generatorMethodDefault)
Sets the ID generator method default.

Parameters:
generatorMethodDefault - The new generator default method.

sink

public Sink sink()
Returns a clone of the default sink used by this model.

Returns:
A sink.

setSink

public void setSink(Sink sink)
Sets the default sink used by this model.

Parameters:
sink - The default sink.

source

public Source source()
Returns a clone of the default source used by this model.

Returns:
A source.

setSource

public void setSource(Source source)
Sets the default source used by this model.

Parameters:
source - The default source.

putRedefine

public void putRedefine(ModelComponent redefined,
                        ModelComponent redefiner)
Adds a redefine from the original component, redefined, to the replacement component, redefiner.

Parameters:
redefined - The original component.
redefiner - The replacement component.

removeRedefine

public void removeRedefine(ModelComponent redefined)
Removes the redefine for redefined.

Parameters:
redefined - The component whose redefine should be removed.

getRedefiner

public ModelComponent getRedefiner(ModelComponent redefined)
Returns the component that redefines redefined.

Parameters:
redefined - The original component.
Returns:
The replacement component or redefined if no redefine exists.

getRedefined

public ModelComponent getRedefined(ModelComponent redefiner)
Returns the component that is redefined by redefiner.

Parameters:
redefiner - The replacement component.
Returns:
The original component or redefiner if no redefine exists.

toString

public String toString()
Overrides:
toString in class Object

getUniqueID

public String getUniqueID()

setUniqueID

public void setUniqueID(String uniqueID)


C24 Technologies © 2002-2012: All Rights Reserved.