blob: 2cbd3c623279641a2b2b29b80082c3296b6b4088 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:15 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.eclipse.persistence.sdo.helper (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.eclipse.persistence.sdo.helper (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/sdo/dataobjects/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/persistence/sdo/helper/delegates/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sdo/helper/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.persistence.sdo.helper</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/CodeWriter.html" title="interface in org.eclipse.persistence.sdo.helper">CodeWriter</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>:This interface can be implemented and used in conjunction with SDOClassGenerator
to write the generated source as desired.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SchemaLocationResolver.html" title="interface in org.eclipse.persistence.sdo.helper">SchemaLocationResolver</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Interface that can be optionally implemented to resolve the
value for the schemaLocation attribute of generated imports and includes when generating schemas.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SchemaResolver.html" title="interface in org.eclipse.persistence.sdo.helper">SchemaResolver</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Interface that can be optionally implemented to resolve imported and included schemas.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOClassGeneratorListener.html" title="interface in org.eclipse.persistence.sdo.helper">SDOClassGeneratorListener</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Optionally user can implement this interface to provide their own extra content
to the generated source files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDODataFactory.html" title="interface in org.eclipse.persistence.sdo.helper">SDODataFactory</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: The implementation of commonj.sdo.helper.DataFactory</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOHelperContext.HelperContextResolver.html" title="interface in org.eclipse.persistence.sdo.helper">SDOHelperContext.HelperContextResolver</a></td>
<td class="colLast">
<div class="block">Strategy for <code>HelperContext</code> creation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOTypeHelper.html" title="interface in org.eclipse.persistence.sdo.helper">SDOTypeHelper</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Helper to provide access to declared SDO Types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOXMLHelper.html" title="interface in org.eclipse.persistence.sdo.helper">SDOXMLHelper</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Helper to transform XML documents into DataObects and DataObjects into XML documents.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOXSDHelper.html" title="interface in org.eclipse.persistence.sdo.helper">SDOXSDHelper</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Provides access to additional information when the Type or Property is defined by an XML Schema (XSD).</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/ApplicationAccessWLS.html" title="class in org.eclipse.persistence.sdo.helper">ApplicationAccessWLS</a></td>
<td class="colLast">
<div class="block">INTERNAL:
This class using WLS classed to get unique application ID.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/ApplicationResolver.html" title="class in org.eclipse.persistence.sdo.helper">ApplicationResolver</a></td>
<td class="colLast">
<div class="block">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.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/AttributeMimeTypePolicy.html" title="class in org.eclipse.persistence.sdo.helper">AttributeMimeTypePolicy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/ClassBuffer.html" title="class in org.eclipse.persistence.sdo.helper">ClassBuffer</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: This class maintains information about a generated class and its corresponding interface</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/DataObjectInputStream.html" title="class in org.eclipse.persistence.sdo.helper">DataObjectInputStream</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/DefaultSchemaLocationResolver.html" title="class in org.eclipse.persistence.sdo.helper">DefaultSchemaLocationResolver</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: 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</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/DefaultSchemaResolver.html" title="class in org.eclipse.persistence.sdo.helper">DefaultSchemaResolver</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Default implementation of the org.eclipse.persistence.sdo.helper.SchemaResolver interface</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/DynamicClassWriter.html" title="class in org.eclipse.persistence.sdo.helper">DynamicClassWriter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/FileCodeWriter.html" title="class in org.eclipse.persistence.sdo.helper">FileCodeWriter</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>:Used in conjunction with SDOClassGenerator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/InstanceClassConverter.html" title="class in org.eclipse.persistence.sdo.helper">InstanceClassConverter</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: 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.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/ListWrapper.html" title="class in org.eclipse.persistence.sdo.helper">ListWrapper</a></td>
<td class="colLast">
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/MapKeyLookupResult.html" title="class in org.eclipse.persistence.sdo.helper">MapKeyLookupResult</a></td>
<td class="colLast">
<div class="block">Class for wrapping cache key lookup results.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SchemaResolverWrapper.html" title="class in org.eclipse.persistence.sdo.helper">SchemaResolverWrapper</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: 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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOClassGenerator.html" title="class in org.eclipse.persistence.sdo.helper">SDOClassGenerator</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Generate Java interfaces and implementation classes from a list of SDO Type objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOClassLoader.html" title="class in org.eclipse.persistence.sdo.helper">SDOClassLoader</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: A custom classloader used to dynamically create classes as needed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOCopyHelper.html" title="class in org.eclipse.persistence.sdo.helper">SDOCopyHelper</a></td>
<td class="colLast">
<div class="block"><b>Purpose:</b>
A helper class for making deep or shallow copies of DataObjects.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOCSUnmarshalListener.html" title="class in org.eclipse.persistence.sdo.helper">SDOCSUnmarshalListener</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Implementation of XMLUnmarshalListener used when unmarshalling XML to XMLDocuments</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDODataHelper.html" title="class in org.eclipse.persistence.sdo.helper">SDODataHelper</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: A helper class for performing data conversions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOEqualityHelper.html" title="class in org.eclipse.persistence.sdo.helper">SDOEqualityHelper</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: A helper class for checking deep or shallow equality of DataObjects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOFragmentMappingAttributeAccessor.html" title="class in org.eclipse.persistence.sdo.helper">SDOFragmentMappingAttributeAccessor</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: 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".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOHelperContext.html" title="class in org.eclipse.persistence.sdo.helper">SDOHelperContext</a></td>
<td class="colLast">
<div class="block"><b>Purpose:</b>
This class represents a local HelperContext.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOHelperContext.MyNotificationFilter.html" title="class in org.eclipse.persistence.sdo.helper">SDOHelperContext.MyNotificationFilter</a></td>
<td class="colLast">
<div class="block">INTERNAL:
This class will be handed in as a parameter when adding a JBoss notification listener.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOMarshalListener.html" title="class in org.eclipse.persistence.sdo.helper">SDOMarshalListener</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Implementation of XMLMarshalListener used when marshalling DataObjects to XML</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOMethodAttributeAccessor.html" title="class in org.eclipse.persistence.sdo.helper">SDOMethodAttributeAccessor</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: 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".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOSchemaGenerator.html" title="class in org.eclipse.persistence.sdo.helper">SDOSchemaGenerator</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b> SDOSchemaGenerator generates an XSD (returned as a String)
from a list of SDO Type objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOTypesGenerator.html" title="class in org.eclipse.persistence.sdo.helper">SDOTypesGenerator</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Called from XSDHelper define methods to generate SDO Types from a Schema</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOUnmappedContentHandler.html" title="class in org.eclipse.persistence.sdo.helper">SDOUnmappedContentHandler</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Called during XMLHelper load methods when there is unknown content in an XML document.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/SDOUnmarshalListener.html" title="class in org.eclipse.persistence.sdo.helper">SDOUnmarshalListener</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Implementation of XMLUnmarshalListener used when unmarshalling XML to XMLDocuments</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/sdo/helper/XPathEngine.html" title="class in org.eclipse.persistence.sdo.helper">XPathEngine</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Perform operations based on SDO XPath against DataObjects.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/sdo/dataobjects/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/persistence/sdo/helper/delegates/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sdo/helper/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>