diff options
| author | Eike Stepper | 2012-06-05 11:19:15 +0000 |
|---|---|---|
| committer | Eike Stepper | 2012-06-05 11:19:15 +0000 |
| commit | e5bc42789a5fa73d5f2c9a2dac4f0d0c177f9b63 (patch) | |
| tree | fa7ac6f5500431fd69a4f27d61fe6ec64a39e335 /plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo | |
| parent | e2fa7de2e0249c3d4b6c603a1694197453e45c38 (diff) | |
| download | cdo-e5bc42789a5fa73d5f2c9a2dac4f0d0c177f9b63.tar.gz cdo-e5bc42789a5fa73d5f2c9a2dac4f0d0c177f9b63.tar.xz cdo-e5bc42789a5fa73d5f2c9a2dac4f0d0c177f9b63.zip | |
[381356] Support prefetching through CDO URI formats
https://bugs.eclipse.org/bugs/show_bug.cgi?id=381356
Diffstat (limited to 'plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo')
7 files changed, 163 insertions, 66 deletions
diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/CDOResource.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/CDOResource.html index f859f31aad..600d025b26 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/CDOResource.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/CDOResource.html @@ -117,7 +117,8 @@ Interface CDOResource</H2> <P> -<!-- begin-user-doc --> A representation of the model object '<em><b>CDO Resource</b></em>'. +<!-- begin-user-doc --> + A representation of the model object '<em><b>CDO Resource</b></em>'. <P> <P> @@ -187,6 +188,14 @@ Interface CDOResource</H2> <BR> </TD> </TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/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/eclipse/emf/cdo/eresource/CDOResource.html#PREFETCH_PARAMETER">PREFETCH_PARAMETER</A></B></CODE> + +<BR> + </TD> +</TR> </TABLE> <A NAME="fields_inherited_from_class_org.eclipse.emf.cdo.eresource.CDOResourceNode"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> @@ -237,7 +246,7 @@ Interface CDOResource</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getResourceSet()">getResourceSet</A></B>()</CODE> <BR> - Returns the value of the '<em><b>Resource Set</b></em>' attribute. <!</TD> + Returns the value of the '<em><b>Resource Set</b></em>' attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -245,7 +254,7 @@ Interface CDOResource</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getTimeStamp()">getTimeStamp</A></B>()</CODE> <BR> - Returns the value of the '<em><b>Time Stamp</b></em>' attribute. <!</TD> + Returns the value of the '<em><b>Time Stamp</b></em>' attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -253,7 +262,7 @@ Interface CDOResource</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getURI()">getURI</A></B>()</CODE> <BR> - Returns the value of the '<em><b>URI</b></em>' attribute. <!</TD> + Returns the value of the '<em><b>URI</b></em>' attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -285,7 +294,7 @@ Interface CDOResource</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#isModified()">isModified</A></B>()</CODE> <BR> - Returns the value of the '<em><b>Modified</b></em>' attribute. <!</TD> + Returns the value of the '<em><b>Modified</b></em>' attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -293,7 +302,7 @@ Interface CDOResource</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#isTrackingModification()">isTrackingModification</A></B>()</CODE> <BR> - Returns the value of the '<em><b>Tracking Modification</b></em>' attribute. <!</TD> + Returns the value of the '<em><b>Tracking Modification</b></em>' attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -310,7 +319,7 @@ Interface CDOResource</H2> <BR> Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getResourceSet()"><CODE><em>Resource Set</em></CODE></A>' - attribute. <!</TD> + attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -319,7 +328,7 @@ Interface CDOResource</H2> <BR> Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getTimeStamp()"><CODE><em>Time Stamp</em></CODE></A>' - attribute. <!</TD> + attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -327,7 +336,7 @@ Interface CDOResource</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#setTrackingModification(boolean)">setTrackingModification</A></B>(boolean value)</CODE> <BR> - Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#isTrackingModification()"><CODE><em>Tracking Modification</em></CODE></A>' attribute. <!</TD> + Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#isTrackingModification()"><CODE><em>Tracking Modification</em></CODE></A>' attribute</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -335,7 +344,7 @@ Interface CDOResource</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#setURI(org.eclipse.emf.common.util.URI)">setURI</A></B>(<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">URI</A> value)</CODE> <BR> - Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getURI()"><CODE><em>URI</em></CODE></A>' attribute. <!</TD> + Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getURI()"><CODE><em>URI</em></CODE></A>' attribute</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.eclipse.emf.cdo.eresource.CDOResourceNode"><!-- --></A> @@ -436,6 +445,20 @@ static final <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang <DD></DD> </DL> </DL> +<HR> + +<A NAME="PREFETCH_PARAMETER"><!-- --></A><H3> +PREFETCH_PARAMETER</H3> +<PRE> +static final <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>PREFETCH_PARAMETER</B></PRE> +<DL> +<DL> +<DT><B>Since:</B></DT> + <DD>4.1</DD> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.emf.cdo.eresource.CDOResource.PREFETCH_PARAMETER">Constant Field Values</A><DT><B>Added</B></DT> + <DD></DD> +</DL> +</DL> <!-- ============ METHOD DETAIL ========== --> @@ -452,11 +475,8 @@ getResourceSet</H3> <PRE> <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/ResourceSet.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource">ResourceSet</A> <B>getResourceSet</B>()</PRE> <DL> -<DD>Returns the value of the '<em><b>Resource Set</b></em>' attribute. <!-- begin-user-doc --> - <p> - If the meaning of the '<em>Resource Set</em>' attribute isn't clear, there really should be more of a description - here... - </p> +<DD>Returns the value of the '<em><b>Resource Set</b></em>' attribute. + <!-- begin-user-doc --> <!-- end-user-doc --> <P> <DD><DL> @@ -480,7 +500,9 @@ setResourceSet</H3> void <B>setResourceSet</B>(<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/ResourceSet.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource">ResourceSet</A> value)</PRE> <DL> <DD>Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getResourceSet()"><CODE><em>Resource Set</em></CODE></A>' - attribute. <!-- begin-user-doc --> <!-- end-user-doc --> + attribute. + <!-- begin-user-doc --> + <!-- end-user-doc --> <P> <DD><DL> </DL> @@ -498,10 +520,9 @@ getURI</H3> <PRE> <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">URI</A> <B>getURI</B>()</PRE> <DL> -<DD>Returns the value of the '<em><b>URI</b></em>' attribute. <!-- begin-user-doc --> - <p> - If the meaning of the '<em>URI</em>' attribute isn't clear, there really should be more of a description here... - </p> +<DD>Returns the value of the '<em><b>URI</b></em>' attribute. + <!-- begin-user-doc --> + The URI format is explained in <A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIUtil.html" title="class in org.eclipse.emf.cdo.util"><CODE>CDOURIUtil</CODE></A> and <A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIData.html" title="class in org.eclipse.emf.cdo.util"><CODE>CDOURIData</CODE></A>. <!-- end-user-doc --> <P> <DD><DL> @@ -524,8 +545,10 @@ setURI</H3> <PRE> void <B>setURI</B>(<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">URI</A> value)</PRE> <DL> -<DD>Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getURI()"><CODE><em>URI</em></CODE></A>' attribute. <!-- - begin-user-doc --> <!-- end-user-doc --> +<DD>Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getURI()"><CODE><em>URI</em></CODE></A>' attribute. + <!-- begin-user-doc --> + The URI format is explained in <A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIUtil.html" title="class in org.eclipse.emf.cdo.util"><CODE>CDOURIUtil</CODE></A> and <A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIData.html" title="class in org.eclipse.emf.cdo.util"><CODE>CDOURIData</CODE></A>. + <!-- end-user-doc --> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true#setURI(org.eclipse.emf.common.util.URI)" title="class or interface in org.eclipse.emf.ecore.resource">setURI</A></CODE> in interface <CODE><A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource">Resource</A></CODE></DL> @@ -544,11 +567,8 @@ getContents</H3> <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/EList.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">EList</A><<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</A>> <B>getContents</B>()</PRE> <DL> <DD>Returns the value of the '<em><b>Contents</b></em>' containment reference list. The list contents are of type - <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore"><CODE>EObject</CODE></A>. <!-- begin-user-doc --> - <p> - If the meaning of the '<em>Contents</em>' containment reference list isn't clear, there really should be more of a - description here... - </p> + <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore"><CODE>EObject</CODE></A>. + <!-- begin-user-doc --> <!-- end-user-doc --> <P> <DD><DL> @@ -570,11 +590,8 @@ isModified</H3> <PRE> boolean <B>isModified</B>()</PRE> <DL> -<DD>Returns the value of the '<em><b>Modified</b></em>' attribute. <!-- begin-user-doc --> - <p> - If the meaning of the '<em>Modified</em>' attribute isn't clear, there really should be more of a description - here... - </p> +<DD>Returns the value of the '<em><b>Modified</b></em>' attribute. + <!-- begin-user-doc --> <!-- end-user-doc --> <P> <DD><DL> @@ -598,7 +615,8 @@ setModified</H3> void <B>setModified</B>(boolean value)</PRE> <DL> <DD>Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#isModified()"><CODE><em>Modified</em></CODE></A>' attribute. - <!-- begin-user-doc --> <!-- end-user-doc --> + <!-- begin-user-doc --> + <!-- end-user-doc --> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true#setModified(boolean)" title="class or interface in org.eclipse.emf.ecore.resource">setModified</A></CODE> in interface <CODE><A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource">Resource</A></CODE></DL> @@ -616,11 +634,8 @@ isLoaded</H3> <PRE> boolean <B>isLoaded</B>()</PRE> <DL> -<DD>Returns the value of the '<em><b>Loaded</b></em>' attribute. The default value is <code>"true"</code>. <!-- - begin-user-doc --> - <p> - If the meaning of the '<em>Loaded</em>' attribute isn't clear, there really should be more of a description here... - </p> +<DD>Returns the value of the '<em><b>Loaded</b></em>' attribute. The default value is <code>"true"</code>. + <!-- begin-user-doc --> <!-- end-user-doc --> <P> <DD><DL> @@ -642,11 +657,8 @@ isTrackingModification</H3> <PRE> boolean <B>isTrackingModification</B>()</PRE> <DL> -<DD>Returns the value of the '<em><b>Tracking Modification</b></em>' attribute. <!-- begin-user-doc --> - <p> - If the meaning of the '<em>Tracking Modification</em>' attribute isn't clear, there really should be more of a - description here... - </p> +<DD>Returns the value of the '<em><b>Tracking Modification</b></em>' attribute. + <!-- begin-user-doc --> <!-- end-user-doc --> <P> <DD><DL> @@ -669,7 +681,9 @@ setTrackingModification</H3> <PRE> void <B>setTrackingModification</B>(boolean value)</PRE> <DL> -<DD>Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#isTrackingModification()"><CODE><em>Tracking Modification</em></CODE></A>' attribute. <!-- begin-user-doc --> <!-- end-user-doc --> +<DD>Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#isTrackingModification()"><CODE><em>Tracking Modification</em></CODE></A>' attribute. + <!-- begin-user-doc --> + <!-- end-user-doc --> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true#setTrackingModification(boolean)" title="class or interface in org.eclipse.emf.ecore.resource">setTrackingModification</A></CODE> in interface <CODE><A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource">Resource</A></CODE></DL> @@ -688,11 +702,8 @@ getErrors</H3> <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/EList.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">EList</A><<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.Diagnostic.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource">Resource.Diagnostic</A>> <B>getErrors</B>()</PRE> <DL> <DD>Returns the value of the '<em><b>Errors</b></em>' attribute list. The list contents are of type - <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.Diagnostic.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource"><CODE>Resource.Diagnostic</CODE></A>. <!-- begin-user-doc --> - <p> - If the meaning of the '<em>Errors</em>' attribute list isn't clear, there really should be more of a description - here... - </p> + <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.Diagnostic.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource"><CODE>Resource.Diagnostic</CODE></A>. + <!-- begin-user-doc --> <!-- end-user-doc --> <P> <DD><DL> @@ -716,11 +727,8 @@ getWarnings</H3> <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/EList.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">EList</A><<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.Diagnostic.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource">Resource.Diagnostic</A>> <B>getWarnings</B>()</PRE> <DL> <DD>Returns the value of the '<em><b>Warnings</b></em>' attribute list. The list contents are of type - <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.Diagnostic.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource"><CODE>Resource.Diagnostic</CODE></A>. <!-- begin-user-doc --> - <p> - If the meaning of the '<em>Warnings</em>' attribute list isn't clear, there really should be more of a description - here... - </p> + <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.Diagnostic.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource"><CODE>Resource.Diagnostic</CODE></A>. + <!-- begin-user-doc --> <!-- end-user-doc --> <P> <DD><DL> @@ -743,11 +751,8 @@ getTimeStamp</H3> <PRE> long <B>getTimeStamp</B>()</PRE> <DL> -<DD>Returns the value of the '<em><b>Time Stamp</b></em>' attribute. <!-- begin-user-doc --> - <p> - If the meaning of the '<em>Time Stamp</em>' attribute isn't clear, there really should be more of a description - here... - </p> +<DD>Returns the value of the '<em><b>Time Stamp</b></em>' attribute. + <!-- begin-user-doc --> <!-- end-user-doc --> <P> <DD><DL> @@ -771,7 +776,9 @@ setTimeStamp</H3> void <B>setTimeStamp</B>(long value)</PRE> <DL> <DD>Sets the value of the '<A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getTimeStamp()"><CODE><em>Time Stamp</em></CODE></A>' - attribute. <!-- begin-user-doc --> <!-- end-user-doc --> + attribute. + <!-- begin-user-doc --> + <!-- end-user-doc --> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true#setTimeStamp(long)" title="class or interface in org.eclipse.emf.ecore.resource">setTimeStamp</A></CODE> in interface <CODE><A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource">Resource</A></CODE></DL> diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/CDOResourceFactory.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/CDOResourceFactory.html index d81453c03b..1618c57566 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/CDOResourceFactory.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/CDOResourceFactory.html @@ -117,6 +117,12 @@ Interface CDOResourceFactory</H2> <P> Creates <A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>CDOResource</CODE></A> instances. + <p> + Note that the only important task of this factory is to instantiate a <A HREF="../../../../../org/eclipse/emf/cdo/eresource/impl/CDOResourceImpl.html" title="class in org.eclipse.emf.cdo.eresource.impl"><CODE>CDOResourceImpl</CODE></A> and mark it + <A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#isExisting()"><CODE>existing</CODE></A> or not. All further <A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#getURI()"><CODE>URI</CODE></A> processing + is done later on in the registration process, especially in <A HREF="../../../../../org/eclipse/emf/cdo/eresource/impl/CDOResourceImpl.html#basicSetResourceSet(org.eclipse.emf.ecore.resource.ResourceSet, org.eclipse.emf.common.notify.NotificationChain)"><CODE>CDOResourceImpl.basicSetResourceSet()</CODE></A>. + <p> + The recognized URI formats are explained in <A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIUtil.html" title="class in org.eclipse.emf.cdo.util"><CODE>CDOURIUtil</CODE></A> and <A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIData.html" title="class in org.eclipse.emf.cdo.util"><CODE>CDOURIData</CODE></A>. <P> <P> diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/impl/CDOResourceImpl.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/impl/CDOResourceImpl.html index 13882839d0..c57d80724a 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/impl/CDOResourceImpl.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/eresource/impl/CDOResourceImpl.html @@ -273,7 +273,7 @@ Class CDOResourceImpl</H2> <TH ALIGN="left"><B>Fields inherited from interface org.eclipse.emf.cdo.eresource.<A HREF="../../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource">CDOResource</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="../../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#OPTION_SAVE_BASE_URI">OPTION_SAVE_BASE_URI</A>, <A HREF="../../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#OPTION_SAVE_OVERRIDE_TRANSACTION">OPTION_SAVE_OVERRIDE_TRANSACTION</A>, <A HREF="../../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#OPTION_SAVE_PROGRESS_MONITOR">OPTION_SAVE_PROGRESS_MONITOR</A></CODE></TD> +<TD><CODE><A HREF="../../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#OPTION_SAVE_BASE_URI">OPTION_SAVE_BASE_URI</A>, <A HREF="../../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#OPTION_SAVE_OVERRIDE_TRANSACTION">OPTION_SAVE_OVERRIDE_TRANSACTION</A>, <A HREF="../../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#OPTION_SAVE_PROGRESS_MONITOR">OPTION_SAVE_PROGRESS_MONITOR</A>, <A HREF="../../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html#PREFETCH_PARAMETER">PREFETCH_PARAMETER</A></CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_org.eclipse.emf.cdo.eresource.CDOResourceNode"><!-- --></A> diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/CDOURIData.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/CDOURIData.html index 54071c2be7..435573e2f2 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/CDOURIData.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/CDOURIData.html @@ -110,7 +110,42 @@ Class CDOURIData</H2> <P> -Represents the CDO-specific URI data needed to access a resource in a repository. +Represents a CDO-specific <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util"><CODE>URI</CODE></A> in connection-aware format. + <p> + CDO URIs are in one of two different formats, either canonical or connection-aware. The connection-aware format is: + + <blockquote><b>cdo.net4j.</b> <i>ConnectorType</i> <b>://</b> [<i>User</i> [<b>:</b> <i>Password</i>] <b>@</b>] + <i>ConnectorSpecificAuthority</i> <b>/</b> <i>RepositoryName</i> <b>/</b> <i>ResourcePath</i> [<b>?</b> <i>Param</i><b>=</b><i>Value</i> + (<b>&</b> <i>Param</i><b>=</b><i>Value</i>)*]</blockquote> + + The non-terminals being: + <p> + <ul> + <li><i>ConnectorType</i>: one of <b>tcp</b> | <b>ssl</b> | <b>jvm</b> | <b>http</b> + <li><i>User/Password</i>: to be provided if the repository is configured with an + <A HREF="../../../../../../../org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/security/IUserManager.html?is-external=true" title="class or interface in org.eclipse.net4j.util.security"><CODE>IUserManager</CODE></A> and, hence, triggers authentication on the client. Note: the + password may be stored in resources in clear text! + <li><i>ConnectorSpecificAuthority</i>: examples are + <ul> + <li><i>Host</i> [<b>:</b> <i>Port</i>] (if <i>ConnectorType</i> is <b>tcp</b>) + <li><i>AcceptorName</i> (if <i>ConnectorType</i> is <b>jvm</b>) + </ul> + <li><i>RepositoryName</i>: the <A HREF="../../../../../org/eclipse/emf/cdo/common/CDOCommonRepository.html#getName()"><CODE>name</CODE></A> of the repository (not the <A HREF="../../../../../org/eclipse/emf/cdo/common/CDOCommonRepository.html#getUUID()"><CODE>UUID</CODE></A>!). + <li><i>ResourcePath</i>: the full path of the <A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> within the repository, segments separated by slashes, no leading slash. + <li><i>Param</i>: one of the following + <ul> + <li><b>branch</b>: the value must be a <A HREF="../../../../../org/eclipse/emf/cdo/common/branch/CDOBranch.html#getPathName()"><CODE>branch path</CODE></A>, the full path of the branch in the branch tree, segments separated by slashes, no leading slash, defaults to <b>MAIN</b>. + <li><b>time</b>: the value must be the time at which the resource is supposed to be valid, parseable by SimpleDateFormat. The special value <b>HEAD</b> indicates a floating view/transaction that always shows the latest state in the chosen branch, the default if no <i>Time</i> parameter is specified. + <li><b>transactional</b>: a boolean value. The value <b>true</b> forces a the resource to be opened in a transaction rather than in a read-only view. This can not be combined with a <i>Time</i> other than <b>HEAD</b>. + <li><b>prefetch</b>: a boolean value. The value <b>true</b> attempts to load all objects contained by the resource in a single server-round trip and cache the results. + </ul> + </ul> + <p> + Note: With the current design and implementation of connection-aware URI + (mainly CDONet4jViewProvider) it is still unclear when and how the allocated + "resources" (aka IConnector, CDOSession, CDOView, etc) are supposed to be freed! + <p> + For a description of the canonical URI format refer to <A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIUtil.html" title="class in org.eclipse.emf.cdo.util"><CODE>CDOURIUtil</CODE></A>. <P> <P> @@ -217,6 +252,14 @@ Represents the CDO-specific URI data needed to access a resource in a repository </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/1.5.0/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/eclipse/emf/cdo/util/CDOURIData.html#getExtraParameters()">getExtraParameters</A></B>()</CODE> + +<BR> + </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/1.5.0/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/eclipse/emf/cdo/util/CDOURIData.html#getPassWord()">getPassWord</A></B>()</CODE> @@ -716,6 +759,19 @@ public void <B>setTransactional</B>(boolean transactional)</PRE> </DL> <HR> +<A NAME="getExtraParameters()"><!-- --></A><H3> +getExtraParameters</H3> +<PRE> +public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getExtraParameters</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>4.1</DD> +</DL> +</DD> +</DL> +<HR> + <A NAME="toURI()"><!-- --></A><H3> toURI</H3> <PRE> diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/CDOURIUtil.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/CDOURIUtil.html index 33781a2b71..f53a73333d 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/CDOURIUtil.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/CDOURIUtil.html @@ -111,6 +111,31 @@ Class CDOURIUtil</H2> <P> Various static methods that may help with CDO-specific <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util"><CODE>URIs</CODE></A>. + <p> + CDO URIs are in one of two different formats, either canonical or connection-aware. The canonical format is: + + <blockquote><b>cdo://</b> <i>RepositoryUUID</i> <b>/</b> <i>ResourcePath</i> [<b>?</b> <i>Param</i><b>=</b><i>Value</i> + (<b>&</b> <i>Param</i><b>=</b><i>Value</i>)*]</blockquote> + + The non-terminals being: + <p> + <ul> + <li><i>RepositoryUUID</i>: the <A HREF="../../../../../org/eclipse/emf/cdo/common/CDOCommonRepository.html#getUUID()"><CODE>UUID</CODE></A> of the repository. By default it's generated when a repository is first started. + If the default format is not adequate the UUID value can be overridden in the repository setup with the <code>overrideUUID</code> property. + <li><i>ResourcePath</i>: the full path of the <A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> within the repository, segments separated by slashes, no leading slash. + <li><i>Param</i>: one of the following + <ul> + <li><b>prefetch</b>: a boolean value. The value <b>true</b> attempts to load all objects contained by the resource in a single server-round trip and cache the results. + </ul> + </ul> + + URIs in the canonical form to resolve to <A HREF="../../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resources</CODE></A> properly require the <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/ResourceSet.html?is-external=true" title="class or interface in org.eclipse.emf.ecore.resource"><CODE>resource set</CODE></A> to be + configured <i>externally</i> so that the connection to the correct repository can be established, for example: + <blockquote><code>session.openView(resourceSet);</code></blockquote> + + Note that resources preserve their original URI in the scope of the managing <A HREF="../../../../../org/eclipse/emf/cdo/view/CDOView.html" title="interface in org.eclipse.emf.cdo.view"><CODE>view</CODE></A>, that is not necessarily in canonical format. + <p> + For a description of the connection-aware URI format refer to <A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIData.html" title="class in org.eclipse.emf.cdo.util"><CODE>CDOURIData</CODE></A>. <P> <P> @@ -260,7 +285,7 @@ Various static methods that may help with CDO-specific <A HREF="http://download. <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIUtil.html#validateURI(org.eclipse.emf.common.util.URI)">validateURI</A></B>(<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">URI</A> uri)</CODE> <BR> - </TD> + <B>Deprecated.</B> <I></I> </TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> @@ -329,9 +354,12 @@ public static final <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/ja <A NAME="validateURI(org.eclipse.emf.common.util.URI)"><!-- --></A><H3> validateURI</H3> <PRE> -public static void <B>validateURI</B>(<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">URI</A> uri) +<FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> +</FONT>public static void <B>validateURI</B>(<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">URI</A> uri) throws <A HREF="../../../../../org/eclipse/emf/cdo/util/InvalidURIException.html" title="class in org.eclipse.emf.cdo.util">InvalidURIException</A></PRE> <DL> +<DD><B>Deprecated.</B> <I></I> +<P> <DD><DL> <DT><B>Throws:</B> diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/class-use/InvalidURIException.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/class-use/InvalidURIException.html index 66e11d9691..d308a9c9c7 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/class-use/InvalidURIException.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/class-use/InvalidURIException.html @@ -132,7 +132,7 @@ Uses of <A HREF="../../../../../../org/eclipse/emf/cdo/util/InvalidURIException. <TD><CODE><B>CDOURIUtil.</B><B><A HREF="../../../../../../org/eclipse/emf/cdo/util/CDOURIUtil.html#validateURI(org.eclipse.emf.common.util.URI)">validateURI</A></B>(<A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">URI</A> uri)</CODE> <BR> - </TD> + <B>Deprecated.</B> <I></I> </TD> </TR> </TABLE> diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/package-summary.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/package-summary.html index b994b7180c..c8c8ecd88d 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/package-summary.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/util/package-summary.html @@ -157,7 +157,7 @@ Client utility classes, some common interfaces and exceptions. </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIData.html" title="class in org.eclipse.emf.cdo.util">CDOURIData</A></B></TD> -<TD>Represents the CDO-specific URI data needed to access a resource in a repository.</TD> +<TD>Represents a CDO-specific <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/common/util/URI.html?is-external=true" title="class or interface in org.eclipse.emf.common.util"><CODE>URI</CODE></A> in connection-aware format.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD WIDTH="15%"><B><A HREF="../../../../../org/eclipse/emf/cdo/util/CDOURIUtil.html" title="class in org.eclipse.emf.cdo.util">CDOURIUtil</A></B></TD> |