|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tuscany.sdo.spi.SDOHelperBase
org.apache.tuscany.sdo.helper.SDOHelperImpl
public class SDOHelperImpl
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.tuscany.sdo.api.SDOHelper |
---|
SDOHelper.MetaDataBuilder, SDOHelper.XMLOptions |
Field Summary |
---|
Fields inherited from class org.apache.tuscany.sdo.spi.SDOHelperBase |
---|
javaToSdoMappings, xsdToSdoMappings |
Fields inherited from interface org.apache.tuscany.sdo.api.SDOHelper |
---|
UNBOUNDED, UNSPECIFIED |
Constructor Summary | |
---|---|
SDOHelperImpl()
|
Method Summary | |
---|---|
void |
addAliasName(Property property,
String aliasName)
Add an aliasName to the specified property. |
void |
addAliasName(Type type,
String aliasName)
Add an aliasName to the specified type. |
void |
addBaseType(Type type,
Type baseType)
Add a baseType to the specified type. |
void |
addChangeListener(DataObject dob,
EventListener listener)
An experimental interface, subject to possible change that permits registration of an event listener with a DataObject instance |
protected void |
addInstanceProperty(org.eclipse.emf.ecore.EModelElement metaObject,
Property property,
Object value)
|
void |
addPropertyInstanceProperty(Property definedProperty,
Property instanceProperty,
Object value)
Add anf instance property to the specified property. |
void |
addTypeInstanceProperty(Type definedType,
Property instanceProperty,
Object value)
Add an instance property to the specified type. |
String |
convertToString(Type dataType,
Object value)
Converts an instance of a data type to a string literal representation. |
CopyHelper |
createCrossScopeCopyHelper(HelperContext hc)
Create a new cross scope CopyHelper. |
DataGraph |
createDataGraph()
Create an empty data graph. |
DataObject |
createDataTypeWrapper(Type dataType,
Object value)
Create a DataObject wrapper for an instance of the specified dataType. |
Object |
createFromString(Type dataType,
String literal)
Creates an instance of a data type from the specified string. |
HelperContext |
createHelperContext()
Create a non-extensible HelperContext to provide access to a consistent set of Helpers which make use of a new TypeHelper instance to provide scope for type definitions. |
HelperContext |
createHelperContext(boolean extensibleNamespaces)
Create a HelperContext to provide access to a consistent set of Helpers which make use of a new TypeHelper instance to provide scope for type definitions. |
HelperContext |
createHelperContext(boolean extensibleNamespaces,
Map options)
Create a non-extensible HelperContext to provide access to a consistent set of Helpers which make use of a new TypeHelper instance to provide scope for type definitions. |
HelperContext |
createHelperContext(Map options)
create a non-extensible HelperContext with default load/save options |
Property |
createOpenContentProperty(HelperContext hc,
String uri,
String name,
Type type)
Create a new open content property in the specified TypeHelper scope. |
Property |
createProperty(Type containingType,
String name,
Type propertyType)
Create a new property in the specified containingType. |
Type |
createType(HelperContext hc,
String uri,
String name,
boolean isDataType)
Create a Type in the specified TypeHelper scope. |
XMLStreamHelper |
createXMLStreamHelper(HelperContext hc)
Create a new XMLStreamHelper, with visibility to types in the specified HelperContext scope. |
List |
getEnumerationFacet(Type type)
Return Enumeration facet |
Type |
getJavaSDOType(Class javaClass)
Get the SDO built-in type corresponding to the specified Java instanceClass. |
int |
getLowerBound(Property property)
Return the lower bound of the specified property or 1 by default |
List |
getOpenContentProperties(DataObject dataObject)
Gets the open content subset of the specified DataObject's instance properties. |
List |
getPatternFacet(Type type)
Return Pattern facet |
Sequence |
getSubstitutionValues(DataObject dataObject,
Property head)
Gets the Sequence corresponding to the specified substitutable Property of the specified DataObject. |
List |
getTypes(HelperContext hc,
String uri)
Gets all of the types associated with a uri. |
int |
getUpperBound(Property property)
Return the upper bound of the specified property or -1 if unbounded. |
Type |
getXSDSDOType(String xsdType)
Get the SDO built-in type corresponding to the specified XSD type in the XML Schema namespace ("http://www.w3.org/2001/XMLSchema"). |
boolean |
isDocumentRoot(Type type)
Return true if the specified type is a special DocumentRoot Type. |
boolean |
isMany(Property property,
DataObject context)
Returns whether the Property is many-valued given the specified context. |
boolean |
isRequired(Property property)
Return whether at least one value is required for a valid instance of the specified property. |
static DataGraph |
loadDataGraph(InputStream inputStream,
Map options)
|
DataGraph |
loadDataGraph(InputStream inputStream,
Map options,
HelperContext scope)
Load a serialized data graph from the specified insputStream. |
void |
registerDataGraphTypes(DataGraph dataGraph,
List types)
Registers the specified type (s) to be serialized along with
the data object (s) in the graph. |
protected void |
registerLoadingScope(Map options,
TypeHelper scope)
|
void |
removeChangeListener(DataObject dob,
EventListener listener)
An experimental interface, subject to possible change that permits deregistration of an event listener with a DataObject instance |
void |
saveDataGraph(DataGraph dataGraph,
OutputStream outputStream,
Map options)
Serialize the specified data graph to the specified outputStream. |
void |
setAbstract(Type type,
boolean isAbstract)
Set the isAbstract value of the specified type. |
void |
setContainment(Property property,
boolean isContainment)
Set the isContainment value of the specified property. |
void |
setDefault(Property property,
String defaultValue)
Set the default value of the specified property. |
void |
setJavaClassName(Type type,
String javaClassName)
Set the isAbstract value of the specified type. |
void |
setMany(Property property,
boolean isMany)
Set the isMany value of the specified property. |
void |
setOpen(Type type,
boolean isOpen)
Set the isOpen value of the specified type. |
void |
setOpposite(Property property,
Property opposite)
Set the opposite value of the specified property. |
void |
setPropertyXMLKind(Property property,
boolean isXmlElement)
Set a SDO property to become an XSD element or attribute |
void |
setReadOnly(Property property,
boolean isReadOnly)
Set the isReadOnly value of the specified property. |
void |
setRootObject(DataGraph dataGraph,
DataObject rootObject)
Set the root object of a data graph. |
void |
setSequenced(Type type,
boolean isSequenced)
Set the isSequenced value of the specified type. |
Methods inherited from class org.apache.tuscany.sdo.spi.SDOHelperBase |
---|
createObjectInputStream, createObjectOutputStream, getMetaDataBuilder, getXPath, getXPath |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.tuscany.sdo.api.SDOHelper |
---|
createObjectInputStream, createObjectOutputStream, getMetaDataBuilder, getXPath |
Constructor Detail |
---|
public SDOHelperImpl()
Method Detail |
---|
public DataObject createDataTypeWrapper(Type dataType, Object value)
SDOHelper
createDataTypeWrapper
in interface SDOHelper
dataType
- a Type for which isDataType() returns true.value
- the instance value.
public Object createFromString(Type dataType, String literal)
SDOHelper
createFromString
in interface SDOHelper
dataType
- a Type, for which isDataType() returns true, to instantiate.literal
- the string value of the dataType.
SDOHelper.convertToString(Type, Object)
public String convertToString(Type dataType, Object value)
SDOHelper
convertToString
in interface SDOHelper
dataType
- the Type, for which isDataType() returns true, of the value to convert.value
- a value of the dataType.
SDOHelper.createFromString(Type, String)
public Type getXSDSDOType(String xsdType)
SDOHelper
getXSDSDOType
in interface SDOHelper
xsdType
- a type name in the XML Schema namespace.
public Sequence getSubstitutionValues(DataObject dataObject, Property head)
SDOHelper
getSubstitutionValues
in interface SDOHelper
dataObject
- the data object.head
- a substitution group head property.
public Type getJavaSDOType(Class javaClass)
SDOHelper
getJavaSDOType
in interface SDOHelper
javaClass
- the Java instanceClass of the type.
public boolean isRequired(Property property)
SDOHelper
isRequired
in interface SDOHelper
public int getUpperBound(Property property)
SDOHelper
getUpperBound
in interface SDOHelper
public int getLowerBound(Property property)
SDOHelper
getLowerBound
in interface SDOHelper
public List getEnumerationFacet(Type type)
SDOHelper
getEnumerationFacet
in interface SDOHelper
public List getPatternFacet(Type type)
SDOHelper
getPatternFacet
in interface SDOHelper
public boolean isMany(Property property, DataObject context)
SDOHelper
isMany
in interface SDOHelper
property
- The Property in questioncontext
- The context to check whether the specified Property is many-valued
public DataGraph createDataGraph()
SDOHelper
createDataGraph
in interface SDOHelper
public void setRootObject(DataGraph dataGraph, DataObject rootObject)
SDOHelper
setRootObject
in interface SDOHelper
dataGraph
- the data graph in which to set the root object.rootObject
- the root object.public static DataGraph loadDataGraph(InputStream inputStream, Map options) throws IOException
IOException
protected void registerLoadingScope(Map options, TypeHelper scope)
public DataGraph loadDataGraph(InputStream inputStream, Map options, HelperContext scope) throws IOException
SDOHelper
loadDataGraph
in interface SDOHelper
inputStream
- the inputStream of the data graph.options
- loader control options, or null.scope
- the HelperContext in which to register deserialized Types and to find Types when
creating DataObject instances, or null for default HelperContext.
IOException
public void saveDataGraph(DataGraph dataGraph, OutputStream outputStream, Map options) throws IOException
SDOHelper
saveDataGraph
in interface SDOHelper
dataGraph
- the data graph to save.outputStream
- the outputStream for the data graph.options
- serializer control options, or null.
IOException
public void registerDataGraphTypes(DataGraph dataGraph, List types)
SDOHelper
type
(s) to be serialized along with
the data object
(s) in the graph. For example, the list of types returned from
TypeHelper.define(commonj.sdo.DataObject)
can be registered with this method, allowing deserialization of
instances of a dynamically defined model.
registerDataGraphTypes
in interface SDOHelper
dataGraph
- the DataGraph in which to register the specified type(s).types
- a list containing the type(s) to be registered (TBD or null to automatically register all
types used by the objects in the DataGraph).public HelperContext createHelperContext()
SDOHelper
createHelperContext
in interface SDOHelper
createHelperContext
in class SDOHelperBase
SDOHelper.createHelperContext(boolean)
public HelperContext createHelperContext(boolean extensibleNamespaces)
SDOHelper
createHelperContext
in interface SDOHelper
extensibleNamespaces
- true if the contents of a namespaces should be incrementally modifiable over time
public HelperContext createHelperContext(Map options)
SDOHelper
createHelperContext
in interface SDOHelper
options
- default load/save options from XMLOptions
public HelperContext createHelperContext(boolean extensibleNamespaces, Map options)
SDOHelper
createHelperContext
in interface SDOHelper
options
- Map of default XMLOptions
SDOHelper.createHelperContext(boolean)
public CopyHelper createCrossScopeCopyHelper(HelperContext hc)
SDOHelper
createCrossScopeCopyHelper
in interface SDOHelper
public XMLStreamHelper createXMLStreamHelper(HelperContext hc)
SDOHelper
createXMLStreamHelper
in interface SDOHelper
hc
- the HelperContext to use for locating types.
public List getTypes(HelperContext hc, String uri)
SDOHelper
getTypes
in interface SDOHelper
hc
- the HelperContext to use for locating types.uri
- the URI of the Types
public List getOpenContentProperties(DataObject dataObject)
SDOHelper
getOpenContentProperties
in interface SDOHelper
dataObject
- the DataObject instance
public boolean isDocumentRoot(Type type)
SDOHelper
isDocumentRoot
in interface SDOHelper
type
- the Type in question
public Type createType(HelperContext hc, String uri, String name, boolean isDataType)
SDOHelper.MetaDataBuilder
createType
in interface SDOHelper.MetaDataBuilder
public void addBaseType(Type type, Type baseType)
SDOHelper.MetaDataBuilder
addBaseType
in interface SDOHelper.MetaDataBuilder
public void addAliasName(Type type, String aliasName)
SDOHelper.MetaDataBuilder
addAliasName
in interface SDOHelper.MetaDataBuilder
public void setOpen(Type type, boolean isOpen)
SDOHelper.MetaDataBuilder
setOpen
in interface SDOHelper.MetaDataBuilder
public void setSequenced(Type type, boolean isSequenced)
SDOHelper.MetaDataBuilder
setSequenced
in interface SDOHelper.MetaDataBuilder
public void setAbstract(Type type, boolean isAbstract)
SDOHelper.MetaDataBuilder
setAbstract
in interface SDOHelper.MetaDataBuilder
public void setJavaClassName(Type type, String javaClassName)
SDOHelper.MetaDataBuilder
setJavaClassName
in interface SDOHelper.MetaDataBuilder
public Property createProperty(Type containingType, String name, Type propertyType)
SDOHelper.MetaDataBuilder
createProperty
in interface SDOHelper.MetaDataBuilder
public void setPropertyXMLKind(Property property, boolean isXmlElement)
SDOHelper.MetaDataBuilder
setPropertyXMLKind
in interface SDOHelper.MetaDataBuilder
public Property createOpenContentProperty(HelperContext hc, String uri, String name, Type type)
SDOHelper.MetaDataBuilder
createOpenContentProperty
in interface SDOHelper.MetaDataBuilder
public void addAliasName(Property property, String aliasName)
SDOHelper.MetaDataBuilder
addAliasName
in interface SDOHelper.MetaDataBuilder
public void setMany(Property property, boolean isMany)
SDOHelper.MetaDataBuilder
setMany
in interface SDOHelper.MetaDataBuilder
public void setContainment(Property property, boolean isContainment)
SDOHelper.MetaDataBuilder
setContainment
in interface SDOHelper.MetaDataBuilder
public void setDefault(Property property, String defaultValue)
SDOHelper.MetaDataBuilder
setDefault
in interface SDOHelper.MetaDataBuilder
public void setReadOnly(Property property, boolean isReadOnly)
SDOHelper.MetaDataBuilder
setReadOnly
in interface SDOHelper.MetaDataBuilder
public void setOpposite(Property property, Property opposite)
SDOHelper.MetaDataBuilder
setOpposite
in interface SDOHelper.MetaDataBuilder
public void addTypeInstanceProperty(Type definedType, Property instanceProperty, Object value)
SDOHelper.MetaDataBuilder
addTypeInstanceProperty
in interface SDOHelper.MetaDataBuilder
public void addPropertyInstanceProperty(Property definedProperty, Property instanceProperty, Object value)
SDOHelper.MetaDataBuilder
addPropertyInstanceProperty
in interface SDOHelper.MetaDataBuilder
protected void addInstanceProperty(org.eclipse.emf.ecore.EModelElement metaObject, Property property, Object value)
public void addChangeListener(DataObject dob, EventListener listener)
SDOHelper
addChangeListener
in interface SDOHelper
dob
- DataObjectlistener
- EventListenerpublic void removeChangeListener(DataObject dob, EventListener listener)
SDOHelper
removeChangeListener
in interface SDOHelper
dob
- DataObjectlistener
- EventListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |