| <!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 (version 1.7.0_121) on Fri Jan 06 19:36:22 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ProductDerivation (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ProductDerivation (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| 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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProductDerivation.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/lib/conf/PluginValue.html" title="class in org.apache.openjpa.lib.conf"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivations.html" title="class in org.apache.openjpa.lib.conf"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/lib/conf/ProductDerivation.html" target="_top">Frames</a></li> |
| <li><a href="ProductDerivation.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.lib.conf</div> |
| <h2 title="Interface ProductDerivation" class="title">Interface ProductDerivation</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/conf/OpenJPAProductDerivation.html" title="interface in org.apache.openjpa.conf">OpenJPAProductDerivation</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/lib/conf/AbstractProductDerivation.html" title="class in org.apache.openjpa.lib.conf">AbstractProductDerivation</a>, <a href="../../../../../org/apache/openjpa/persistence/jdbc/JDBCPersistenceProductDerivation.html" title="class in org.apache.openjpa.persistence.jdbc">JDBCPersistenceProductDerivation</a>, <a href="../../../../../org/apache/openjpa/jdbc/conf/JDBCProductDerivation.html" title="class in org.apache.openjpa.jdbc.conf">JDBCProductDerivation</a>, <a href="../../../../../org/apache/openjpa/persistence/PersistenceProductDerivation.html" title="class in org.apache.openjpa.persistence">PersistenceProductDerivation</a>, <a href="../../../../../org/apache/openjpa/slice/ProductDerivation.html" title="class in org.apache.openjpa.slice">ProductDerivation</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ProductDerivation</span></pre> |
| <div class="block">Hooks for deriving products with additional functionality. |
| Parses configuration information from global, default or explictly-specified |
| resources. All implementations of this interface will have a chance to mutate |
| a <a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf"><code>Configuration</code></a> both before and after the user-specified |
| configuration data is loaded. The order in which the product derivations are |
| evaluated is determined by the specificity of the derivation type.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.4.1</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Abe White, Pinaki Poddar</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#TYPE_FEATURE">TYPE_FEATURE</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#TYPE_PRODUCT">TYPE_PRODUCT</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#afterSpecificationSet(org.apache.openjpa.lib.conf.Configuration)">afterSpecificationSet</a></strong>(<a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a> conf)</code> |
| <div class="block">Called after the specification has been set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#beforeConfigurationClose(org.apache.openjpa.lib.conf.Configuration)">beforeConfigurationClose</a></strong>(<a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a> conf)</code> |
| <div class="block">Called before the given Configuration is closed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#beforeConfigurationConstruct(org.apache.openjpa.lib.conf.ConfigurationProvider)">beforeConfigurationConstruct</a></strong>(<a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a> cp)</code> |
| <div class="block">Provides the instance with a callback to mutate the initial properties |
| of the <a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf"><code>ConfigurationProvider</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#beforeConfigurationLoad(org.apache.openjpa.lib.conf.Configuration)">beforeConfigurationLoad</a></strong>(<a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a> conf)</code> |
| <div class="block">Provides the instance with the opportunity to mutate |
| <code>conf</code> before the user configuration is applied.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getAnchorsInFile(java.io.File)">getAnchorsInFile</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> |
| <div class="block">Return a List<String> of all the anchors defined in <code>file</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getAnchorsInResource(java.lang.String)">getAnchorsInResource</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resource)</code> |
| <div class="block">Return a List<String> of all the anchors defined in |
| <code>resource</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getConfigurationPrefix()">getConfigurationPrefix</a></strong>()</code> |
| <div class="block">Return the configuration prefix for properties of this product.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getDefaultResourceLocation()">getDefaultResourceLocation</a></strong>()</code> |
| <div class="block">Return a string identifying the default resource location for this |
| product derivation, if one exists.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getSupportedQueryHints()">getSupportedQueryHints</a></strong>()</code> |
| <div class="block">Return set of Query hint keys recognized by this receiver.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getType()">getType</a></strong>()</code> |
| <div class="block">Return the type of derivation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#load(java.io.File,%20java.lang.String)">load</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> anchor)</code> |
| <div class="block">Load given file, or return null if it is not a file this receiver |
| understands.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#load(java.lang.String,%20java.lang.String,%20java.lang.ClassLoader)">load</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resource, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> anchor, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Load the given given resource into the returned ConfigurationProvider, |
| or return null if it is not a resource this receiver understands.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#loadDefaults(java.lang.ClassLoader)">loadDefaults</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Load defaults into the returned ConfigurationProvider, or return null if |
| no defaults are found.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#loadGlobals(java.lang.ClassLoader)">loadGlobals</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Load globals into the returned ConfigurationProvider, or return null if |
| no globals are found.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#validate()">validate</a></strong>()</code> |
| <div class="block">Ensure that this derivation is valid.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="TYPE_PRODUCT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TYPE_PRODUCT</h4> |
| <pre>static final int TYPE_PRODUCT</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.lib.conf.ProductDerivation.TYPE_PRODUCT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="TYPE_FEATURE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TYPE_FEATURE</h4> |
| <pre>static final int TYPE_FEATURE</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.lib.conf.ProductDerivation.TYPE_FEATURE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>int getType()</pre> |
| <div class="block">Return the type of derivation.</div> |
| </li> |
| </ul> |
| <a name="getConfigurationPrefix()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigurationPrefix</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getConfigurationPrefix()</pre> |
| <div class="block">Return the configuration prefix for properties of this product.</div> |
| </li> |
| </ul> |
| <a name="validate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>void validate() |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Ensure that this derivation is valid. This action might consist of |
| loading classes for the product this derivation represents to be sure |
| they exist. Throw any throwable to indicate an invalid derivation. |
| Invalid derivations will not be used.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="loadGlobals(java.lang.ClassLoader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadGlobals</h4> |
| <pre><a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a> loadGlobals(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Load globals into the returned ConfigurationProvider, or return null if |
| no globals are found.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="loadDefaults(java.lang.ClassLoader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadDefaults</h4> |
| <pre><a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a> loadDefaults(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Load defaults into the returned ConfigurationProvider, or return null if |
| no defaults are found.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="load(java.lang.String, java.lang.String, java.lang.ClassLoader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre><a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a> load(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resource, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> anchor, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Load the given given resource into the returned ConfigurationProvider, |
| or return null if it is not a resource this receiver understands. |
| The given class loader may be null.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>anchor</code> - optional named anchor within a multiple-configuration |
| resource</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="load(java.io.File, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre><a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a> load(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> anchor) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Load given file, or return null if it is not a file this receiver |
| understands.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>anchor</code> - optional named anchor within a multiple-configuration file</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getDefaultResourceLocation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultResourceLocation</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDefaultResourceLocation()</pre> |
| <div class="block">Return a string identifying the default resource location for this |
| product derivation, if one exists. If there is no default location, |
| returns <code>null</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getAnchorsInFile(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAnchorsInFile</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getAnchorsInFile(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Return a List<String> of all the anchors defined in <code>file</code>. |
| The returned names are not fully-qualified, so must be used in |
| conjunction with <code>file</code> in calls |
| to <a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#load(java.io.File,%20java.lang.String)"><code>load(java.io.File, String)</code></a>. |
| |
| Returns <code>null</code> or an empty list if no anchors could be found.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getAnchorsInResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAnchorsInResource</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getAnchorsInResource(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resource) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Return a List<String> of all the anchors defined in |
| <code>resource</code>. The returned names are not |
| fully-qualified, so must be used in conjunction with |
| <code>resource</code> in calls to <a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#load(java.io.File,%20java.lang.String)"><code>load(java.io.File, String)</code></a>. |
| |
| Returns <code>null</code> or an empty list if no anchors could be found.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="beforeConfigurationConstruct(org.apache.openjpa.lib.conf.ConfigurationProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeConfigurationConstruct</h4> |
| <pre>boolean beforeConfigurationConstruct(<a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</a> cp)</pre> |
| <div class="block">Provides the instance with a callback to mutate the initial properties |
| of the <a href="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf"><code>ConfigurationProvider</code></a>. This is primarily to alter or |
| add properties that determine what type of configuration is constructed, |
| and therefore is typically used at runtime only.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if given ConfigurationProvider has been mutated.</dd></dl> |
| </li> |
| </ul> |
| <a name="beforeConfigurationLoad(org.apache.openjpa.lib.conf.Configuration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeConfigurationLoad</h4> |
| <pre>boolean beforeConfigurationLoad(<a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a> conf)</pre> |
| <div class="block">Provides the instance with the opportunity to mutate |
| <code>conf</code> before the user configuration is applied.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if given Configuration has been mutated.</dd></dl> |
| </li> |
| </ul> |
| <a name="afterSpecificationSet(org.apache.openjpa.lib.conf.Configuration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>afterSpecificationSet</h4> |
| <pre>boolean afterSpecificationSet(<a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a> conf)</pre> |
| <div class="block">Called after the specification has been set.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if given Configuration has been mutated.</dd></dl> |
| </li> |
| </ul> |
| <a name="beforeConfigurationClose(org.apache.openjpa.lib.conf.Configuration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeConfigurationClose</h4> |
| <pre>void beforeConfigurationClose(<a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a> conf)</pre> |
| <div class="block">Called before the given Configuration is closed.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.9.7</dd></dl> |
| </li> |
| </ul> |
| <a name="getSupportedQueryHints()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSupportedQueryHints</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getSupportedQueryHints()</pre> |
| <div class="block">Return set of Query hint keys recognized by this receiver.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProductDerivation.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/lib/conf/PluginValue.html" title="class in org.apache.openjpa.lib.conf"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/lib/conf/ProductDerivations.html" title="class in org.apache.openjpa.lib.conf"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/lib/conf/ProductDerivation.html" target="_top">Frames</a></li> |
| <li><a href="ProductDerivation.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
