<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.6.0_29) on Thu Nov 21 14:32:32 CET 2013 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
ProductDerivation (OpenJPA Parent POM 2.3.0 API) | |
</TITLE> | |
<META NAME="date" CONTENT="2013-11-21"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
if (location.href.indexOf('is-external=true') == -1) { | |
parent.document.title="ProductDerivation (OpenJPA Parent POM 2.3.0 API)"; | |
} | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<HR> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProductDerivation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/openjpa/lib/conf/PluginValue.html" title="class in org.apache.openjpa.lib.conf"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivations.html" title="class in org.apache.openjpa.lib.conf"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/openjpa/lib/conf/ProductDerivation.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="ProductDerivation.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.openjpa.lib.conf</FONT> | |
<BR> | |
Interface ProductDerivation</H2> | |
<DL> | |
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../org/apache/openjpa/conf/OpenJPAProductDerivation.html" title="interface in org.apache.openjpa.conf">OpenJPAProductDerivation</A></DD> | |
</DL> | |
<DL> | |
<DT><B>All Known Implementing Classes:</B> <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> | |
<DL> | |
<DT><PRE>public interface <B>ProductDerivation</B></DL> | |
</PRE> | |
<P> | |
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. | |
<P> | |
<P> | |
<DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.4.1</DD> | |
<DT><B>Author:</B></DT> | |
<DD>Abe White, Pinaki Poddar</DD> | |
</DL> | |
<HR> | |
<P> | |
<!-- =========== FIELD SUMMARY =========== --> | |
<A NAME="field_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Field Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#TYPE_FEATURE">TYPE_FEATURE</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#TYPE_PRODUCT">TYPE_PRODUCT</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#afterSpecificationSet(org.apache.openjpa.lib.conf.Configuration)">afterSpecificationSet</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> conf)</CODE> | |
<BR> | |
Called after the specification has been set.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#beforeConfigurationClose(org.apache.openjpa.lib.conf.Configuration)">beforeConfigurationClose</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> conf)</CODE> | |
<BR> | |
Called before the given Configuration is closed.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#beforeConfigurationConstruct(org.apache.openjpa.lib.conf.ConfigurationProvider)">beforeConfigurationConstruct</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A> cp)</CODE> | |
<BR> | |
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>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#beforeConfigurationLoad(org.apache.openjpa.lib.conf.Configuration)">beforeConfigurationLoad</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> conf)</CODE> | |
<BR> | |
Provides the instance with the opportunity to mutate | |
<code>conf</code> before the user configuration is applied.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<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></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getAnchorsInFile(java.io.File)">getAnchorsInFile</A></B>(<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> | |
<BR> | |
Return a List<String> of all the anchors defined in <code>file</code>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<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></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getAnchorsInResource(java.lang.String)">getAnchorsInResource</A></B>(<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> | |
<BR> | |
Return a List<String> of all the anchors defined in | |
<code>resource</code>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<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></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getConfigurationPrefix()">getConfigurationPrefix</A></B>()</CODE> | |
<BR> | |
Return the configuration prefix for properties of this product.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<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></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getDefaultResourceLocation()">getDefaultResourceLocation</A></B>()</CODE> | |
<BR> | |
Return a string identifying the default resource location for this | |
product derivation, if one exists.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<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></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getSupportedQueryHints()">getSupportedQueryHints</A></B>()</CODE> | |
<BR> | |
Return set of Query hint keys recognized by this receiver.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#getType()">getType</A></B>()</CODE> | |
<BR> | |
Return the type of derivation.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#load(java.io.File, java.lang.String)">load</A></B>(<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> | |
<BR> | |
Load given file, or return null if it is not a file this receiver | |
understands.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#load(java.lang.String, java.lang.String, java.lang.ClassLoader)">load</A></B>(<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> | |
<BR> | |
Load the given given resource into the returned ConfigurationProvider, | |
or return null if it is not a resource this receiver understands.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#loadDefaults(java.lang.ClassLoader)">loadDefaults</A></B>(<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> | |
<BR> | |
Load defaults into the returned ConfigurationProvider, or return null if | |
no defaults are found.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#loadGlobals(java.lang.ClassLoader)">loadGlobals</A></B>(<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> | |
<BR> | |
Load globals into the returned ConfigurationProvider, or return null if | |
no globals are found.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivation.html#validate()">validate</A></B>()</CODE> | |
<BR> | |
Ensure that this derivation is valid.</TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ FIELD DETAIL =========== --> | |
<A NAME="field_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Field Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="TYPE_PRODUCT"><!-- --></A><H3> | |
TYPE_PRODUCT</H3> | |
<PRE> | |
static final int <B>TYPE_PRODUCT</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.lib.conf.ProductDerivation.TYPE_PRODUCT">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="TYPE_FEATURE"><!-- --></A><H3> | |
TYPE_FEATURE</H3> | |
<PRE> | |
static final int <B>TYPE_FEATURE</B></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.lib.conf.ProductDerivation.TYPE_FEATURE">Constant Field Values</A></DL> | |
</DL> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="getType()"><!-- --></A><H3> | |
getType</H3> | |
<PRE> | |
int <B>getType</B>()</PRE> | |
<DL> | |
<DD>Return the type of derivation. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getConfigurationPrefix()"><!-- --></A><H3> | |
getConfigurationPrefix</H3> | |
<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> <B>getConfigurationPrefix</B>()</PRE> | |
<DL> | |
<DD>Return the configuration prefix for properties of this product. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="validate()"><!-- --></A><H3> | |
validate</H3> | |
<PRE> | |
void <B>validate</B>() | |
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> | |
<DL> | |
<DD>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. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<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></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="loadGlobals(java.lang.ClassLoader)"><!-- --></A><H3> | |
loadGlobals</H3> | |
<PRE> | |
<A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A> <B>loadGlobals</B>(<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> | |
<DL> | |
<DD>Load globals into the returned ConfigurationProvider, or return null if | |
no globals are found. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<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></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="loadDefaults(java.lang.ClassLoader)"><!-- --></A><H3> | |
loadDefaults</H3> | |
<PRE> | |
<A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A> <B>loadDefaults</B>(<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> | |
<DL> | |
<DD>Load defaults into the returned ConfigurationProvider, or return null if | |
no defaults are found. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<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></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="load(java.lang.String, java.lang.String, java.lang.ClassLoader)"><!-- --></A><H3> | |
load</H3> | |
<PRE> | |
<A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A> <B>load</B>(<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> | |
<DL> | |
<DD>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. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>anchor</CODE> - optional named anchor within a multiple-configuration | |
resource | |
<DT><B>Throws:</B> | |
<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></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="load(java.io.File, java.lang.String)"><!-- --></A><H3> | |
load</H3> | |
<PRE> | |
<A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A> <B>load</B>(<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> | |
<DL> | |
<DD>Load given file, or return null if it is not a file this receiver | |
understands. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>anchor</CODE> - optional named anchor within a multiple-configuration file | |
<DT><B>Throws:</B> | |
<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></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDefaultResourceLocation()"><!-- --></A><H3> | |
getDefaultResourceLocation</H3> | |
<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> <B>getDefaultResourceLocation</B>()</PRE> | |
<DL> | |
<DD>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>. | |
<P> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>1.1.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getAnchorsInFile(java.io.File)"><!-- --></A><H3> | |
getAnchorsInFile</H3> | |
<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>> <B>getAnchorsInFile</B>(<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> | |
<DL> | |
<DD>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, java.lang.String)"><CODE>load(java.io.File, String)</CODE></A>. | |
Returns <code>null</code> or an empty list if no anchors could be found. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<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><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><DT><B>Since:</B></DT> | |
<DD>1.1.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getAnchorsInResource(java.lang.String)"><!-- --></A><H3> | |
getAnchorsInResource</H3> | |
<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>> <B>getAnchorsInResource</B>(<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> | |
<DL> | |
<DD>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, java.lang.String)"><CODE>load(java.io.File, String)</CODE></A>. | |
Returns <code>null</code> or an empty list if no anchors could be found. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<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><DT><B>Since:</B></DT> | |
<DD>1.1.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="beforeConfigurationConstruct(org.apache.openjpa.lib.conf.ConfigurationProvider)"><!-- --></A><H3> | |
beforeConfigurationConstruct</H3> | |
<PRE> | |
boolean <B>beforeConfigurationConstruct</B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/ConfigurationProvider.html" title="interface in org.apache.openjpa.lib.conf">ConfigurationProvider</A> cp)</PRE> | |
<DL> | |
<DD>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. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if given ConfigurationProvider has been mutated.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="beforeConfigurationLoad(org.apache.openjpa.lib.conf.Configuration)"><!-- --></A><H3> | |
beforeConfigurationLoad</H3> | |
<PRE> | |
boolean <B>beforeConfigurationLoad</B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> conf)</PRE> | |
<DL> | |
<DD>Provides the instance with the opportunity to mutate | |
<code>conf</code> before the user configuration is applied. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if given Configuration has been mutated.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="afterSpecificationSet(org.apache.openjpa.lib.conf.Configuration)"><!-- --></A><H3> | |
afterSpecificationSet</H3> | |
<PRE> | |
boolean <B>afterSpecificationSet</B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> conf)</PRE> | |
<DL> | |
<DD>Called after the specification has been set. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if given Configuration has been mutated.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="beforeConfigurationClose(org.apache.openjpa.lib.conf.Configuration)"><!-- --></A><H3> | |
beforeConfigurationClose</H3> | |
<PRE> | |
void <B>beforeConfigurationClose</B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> conf)</PRE> | |
<DL> | |
<DD>Called before the given Configuration is closed. | |
<P> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.9.7</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSupportedQueryHints()"><!-- --></A><H3> | |
getSupportedQueryHints</H3> | |
<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>> <B>getSupportedQueryHints</B>()</PRE> | |
<DL> | |
<DD>Return set of Query hint keys recognized by this receiver. | |
<P> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<HR> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<A NAME="navbar_bottom"><!-- --></A> | |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_bottom_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProductDerivation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/openjpa/lib/conf/PluginValue.html" title="class in org.apache.openjpa.lib.conf"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/openjpa/lib/conf/ProductDerivations.html" title="class in org.apache.openjpa.lib.conf"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/openjpa/lib/conf/ProductDerivation.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="ProductDerivation.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
Copyright © 2006–2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved. | |
</BODY> | |
</HTML> |