EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

Package org.eclipse.persistence.sdo.helper

Interface Summary
CodeWriter Purpose:This interface can be implemented and used in conjunction with SDOClassGenerator to write the generated source as desired.
SchemaLocationResolver Purpose: Interface that can be optionally implemented to resolve the value for the schemaLocation attribute of generated imports and includes when generating schemas.
SchemaResolver Purpose: Interface that can be optionally implemented to resolve imported and included schemas.
SDOClassGeneratorListener Purpose: Optionally user can implement this interface to provide their own extra content to the generated source files.
SDODataFactory Purpose: The implementation of commonj.sdo.helper.DataFactory
SDOTypeHelper Purpose: Helper to provide access to declared SDO Types.
SDOXMLHelper Purpose: Helper to transform XML documents into DataObects and DataObjects into XML documents.
SDOXSDHelper Purpose: Provides access to additional information when the Type or Property is defined by an XML Schema (XSD).
 

Class Summary
ApplicationResolver This class provides a means for the user to return application-specific information, such as the application name, which will be used when the logic in SDOHelperContext fails.
AttributeMimeTypePolicy  
ClassBuffer Purpose: This class maintains information about a generated class and its corresponding interface Responsibilities: Hold the StringBuffer contents of the class and interface When the close() method is called the attribute and method buffers are appended to the classbuffer and both the interface buffer and class buffer have the closing brace appended
DataObjectInputStream  
DefaultSchemaLocationResolver Purpose: Default implementation of the org.eclipse.persistence.sdo.helper.SchemaLocationResolver interface By default set a Map keyed on QName of types and value is the schemaLocation
DefaultSchemaResolver Purpose: Default implementation of the org.eclipse.persistence.sdo.helper.SchemaResolver interface Responsibilities: Given the source schema and namespace and schemaLocation values from an import or include return the referenced Schema If a baseSchemaLocation is set it will be prepended to all schemaLocations passed into the resovleSchema methods This implementation will try to open an Inputstream to a URL created from the schemaLocation and return a StreamSource based on that inputstream
DynamicClassWriter  
FileCodeWriter Purpose:Used in conjunction with SDOClassGenerator.
InstanceClassConverter Purpose: A converter used in conjunction with sdoJava:instanceClass The customClass on the converter must be set and that class must have a Constructor that takes a String argument and a toString method.
ListWrapper INTERNAL:

Purpose: This class wraps the ArrayList of currentElements that implement the List interface.

MapKeyLookupResult Class for wrapping cache key lookup results.
SchemaResolverWrapper Purpose: Allow the contained schema resolver to resolve a schema based on a given namespace and schema location, and return either the resolved schema source or null, depending on whether the schema had been processed previously.
SDOClassGenerator Purpose<>/b: Generate Java interfaces and implementation classes from a list of SDO Type objects.
SDOClassLoader Purpose: A custom classloader used to dynamically create classes as needed.
SDOCopyHelper Purpose: A helper class for making deep or shallow copies of DataObjects.
SDOCSUnmarshalListener Purpose: Implementation of XMLUnmarshalListener used when unmarshalling XML to XMLDocuments Responsibilities: When creating a DataObject we need to call setType and setHelperContext with the appropriate values
SDODataHelper Purpose: A helper class for performing data conversions.
SDOEqualityHelper Purpose: A helper class for checking deep or shallow equality of DataObjects.
SDOFragmentMappingAttributeAccessor Purpose: A wrapper class for handling cases when the domain object attributes are to be accessed thru the accessor methods that are called "get" and "set".
SDOHelperContext Purpose: This class represents a local HelperContext.
SDOHelperContext.MyNotificationFilter INTERNAL: This class will be handed in as a parameter when adding a JBoss notification listener.
SDOMarshalListener Purpose: Implementation of XMLMarshalListener used when marshalling DataObjects to XML Responsibilities: Need to do extra work to marshal org.eclipse.persistence.sdo.SDOChangeSummary objects
SDOMethodAttributeAccessor Purpose: A wrapper class for handling cases when the domain object attributes are to be accessed thru the accessor methods that are called "get" and "set".
SDOSchemaGenerator Purpose SDOSchemaGenerator generates an XSD (returned as a String) from a list of SDO Type objects.
SDOTypesGenerator Purpose: Called from XSDHelper define methods to generate SDO Types from a Schema
SDOUnmappedContentHandler Purpose: Called during XMLHelper load methods when there is unknown content in an XML document.
SDOUnmarshalListener Purpose: Implementation of XMLUnmarshalListener used when unmarshalling XML to XMLDocuments Responsibilities: When creating a DataObject we need to call setType and setHelperContext with the appropriate values When we are finished Unmarshalling the root object we need to set up the ChangeSummary objects.
XPathEngine Purpose: Perform operations based on SDO XPath against DataObjects.
 


EclipseLink 2.2.0, build 'v20110202-r8913' API Reference