Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEike Stepper2015-10-06 07:44:34 +0000
committerEike Stepper2015-10-06 07:44:34 +0000
commitaf251ff27a2342071bcbf2254a5b948db1dd45d3 (patch)
tree8dfd5914bb5e43e96ea5e3e0f116468ffc334f76
parent3259e9d702451eae8965688c62c167913c73df34 (diff)
downloadcdo-af251ff27a2342071bcbf2254a5b948db1dd45d3.tar.gz
cdo-af251ff27a2342071bcbf2254a5b948db1dd45d3.tar.xz
cdo-af251ff27a2342071bcbf2254a5b948db1dd45d3.zip
297142: Provide more documentation
https://bugs.eclipse.org/bugs/show_bug.cgi?id=297142
-rw-r--r--plugins/org.eclipse.emf.cdo.doc/html/operators/Doc01_ConfiguringRepositories.html45
-rw-r--r--plugins/org.eclipse.emf.cdo.doc/html/operators/index.html3
-rw-r--r--plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc01_ConfiguringRepositories.java63
3 files changed, 111 insertions, 0 deletions
diff --git a/plugins/org.eclipse.emf.cdo.doc/html/operators/Doc01_ConfiguringRepositories.html b/plugins/org.eclipse.emf.cdo.doc/html/operators/Doc01_ConfiguringRepositories.html
index 4f9d2b78ed..ead2c8ea3a 100644
--- a/plugins/org.eclipse.emf.cdo.doc/html/operators/Doc01_ConfiguringRepositories.html
+++ b/plugins/org.eclipse.emf.cdo.doc/html/operators/Doc01_ConfiguringRepositories.html
@@ -123,6 +123,9 @@ function windowTitle()
<tr><td></td><td>6.8&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_objectTypeCacheSize" title="Chapter in CDO Model Repository Documentation">Property objectTypeCacheSize</a></td></tr>
<tr><td></td><td>6.9&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_columnTypeModifier" title="Chapter in CDO Model Repository Documentation">Property columnTypeModifier</a></td></tr>
<tr><td></td><td>6.10&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_forceIndexes" title="Chapter in CDO Model Repository Documentation">Property forceIndexes</a></td></tr>
+<tr><td></td><td>6.11&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_withRanges" title="Chapter in CDO Model Repository Documentation">Property withRanges</a></td></tr>
+<tr><td></td><td>6.12&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_copyOnBranch" title="Chapter in CDO Model Repository Documentation">Property copyOnBranch</a></td></tr>
+<tr><td></td><td>6.13&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_forceZeroBasedIndex" title="Chapter in CDO Model Repository Documentation">Property forceZeroBasedIndex</a></td></tr>
<tr><td>7&nbsp;</td><td colspan="4"><a href="Doc01_ConfiguringRepositories.html#Element_dbAdapter" title="Chapter in CDO Model Repository Documentation">Element dbAdapter</a></td></tr>
<tr><td>8&nbsp;</td><td colspan="4"><a href="Doc01_ConfiguringRepositories.html#Element_dataSource" title="Chapter in CDO Model Repository Documentation">Element dataSource</a></td></tr>
</table>
@@ -418,6 +421,48 @@ function windowTitle()
<li> XREF
</ul>
+<h3><a name="Property_withRanges"></a>6.11&nbsp;&nbsp;Property withRanges</h3>
+<p>
+ Specifies whether new <a href="../../javadoc/org/eclipse/emf/cdo/common/revision/CDORevision.html" title="Interface in org.eclipse.emf.cdo.common.revision"><code>revisions</code></a> create entire new copies of all their list <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.11/org/eclipse/emf/ecore/EStructuralFeature.html" title="Interface in org.eclipse.emf.ecore"><code>features</code></a>
+ or whether just the list deltas are stored.
+ <p>
+ Possible configuration values are:
+ <ul>
+ <li> <code>false</code> (store new copies of all lists of a revision; default value)
+ <li> <code>true</code> (store only list deltas/ranges of a revision)
+ </ul>
+ <p>
+ This property is only applicable to horizontal mapping strategies in <a href="Doc01_ConfiguringRepositories.html#Property_supportingAudits" title="Chapter in CDO Model Repository Documentation">auditing</a>
+ or <a href="Doc01_ConfiguringRepositories.html#Property_supportingBranches" title="Chapter in CDO Model Repository Documentation">branching</a> repositories.
+
+<h3><a name="Property_copyOnBranch"></a>6.12&nbsp;&nbsp;Property copyOnBranch</h3>
+<p>
+ Specifies whether <b>the first</b> new <a href="../../javadoc/org/eclipse/emf/cdo/common/revision/CDORevision.html" title="Interface in org.eclipse.emf.cdo.common.revision"><code>revisions</code></a> in a <a href="../../javadoc/org/eclipse/emf/cdo/common/branch/CDOBranch.html" title="Interface in org.eclipse.emf.cdo.common.branch"><code>branch</code></a> create entire new copies
+ of all their list <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.11/org/eclipse/emf/ecore/EStructuralFeature.html" title="Interface in org.eclipse.emf.ecore"><code>features</code></a> or whether just the list deltas (relative to the base revisions in the parent branch) are stored.
+ <p>
+ Possible configuration values are:
+ <ul>
+ <li> <code>false</code> (store only list deltas/ranges of the first revision in a branch; default value)
+ <li> <code>true</code> (store new copies of all lists of the first revision in a branch)
+ </ul>
+ <p>
+ This property is only applicable to <a href="Doc01_ConfiguringRepositories.html#Property_withRanges" title="Chapter in CDO Model Repository Documentation">range-based</a> horizontal mapping strategies in
+ <a href="Doc01_ConfiguringRepositories.html#Property_supportingBranches" title="Chapter in CDO Model Repository Documentation">branching</a> repositories.
+
+<h3><a name="Property_forceZeroBasedIndex"></a>6.13&nbsp;&nbsp;Property forceZeroBasedIndex</h3>
+<p>
+ Specifies whether element removals from the beginning of list <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.11/org/eclipse/emf/ecore/EStructuralFeature.html" title="Interface in org.eclipse.emf.ecore"><code>features</code></a> adjust the
+ list indexes of all following elements or whether the first element is allowed to have a non-zero list index.
+ <p>
+ Possible configuration values are:
+ <ul>
+ <li> <code>false</code> (allow non-zero list index for the first list elements; default value)
+ <li> <code>true</code> (force zero list indexes for the first list elements)
+ </ul>
+ <p>
+ This property is only applicable to <a href="Doc01_ConfiguringRepositories.html#Property_withRanges" title="Chapter in CDO Model Repository Documentation">range-based</a> horizontal mapping strategies in
+ <a href="Doc01_ConfiguringRepositories.html#Property_supportingAudits" title="Chapter in CDO Model Repository Documentation">auditing</a> or <a href="Doc01_ConfiguringRepositories.html#Property_supportingBranches" title="Chapter in CDO Model Repository Documentation">branching</a> repositories.
+
<h2><a name="Element_dbAdapter"></a>7&nbsp;&nbsp;Element dbAdapter</h2>
<p>
Defines the <a href="../../../org.eclipse.net4j.db.doc/javadoc/org/eclipse/net4j/db/IDBAdapter.html" title="Interface in org.eclipse.net4j.db"><code>IDBAdapter</code></a> instance of the store that interprets the SQL dialect of the used database.
diff --git a/plugins/org.eclipse.emf.cdo.doc/html/operators/index.html b/plugins/org.eclipse.emf.cdo.doc/html/operators/index.html
index 2a47eb5d36..44c100e2e2 100644
--- a/plugins/org.eclipse.emf.cdo.doc/html/operators/index.html
+++ b/plugins/org.eclipse.emf.cdo.doc/html/operators/index.html
@@ -60,6 +60,9 @@ function windowTitle()
<tr><td></td><td></td><td>6.8&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_objectTypeCacheSize" title="Chapter in CDO Model Repository Documentation">Property objectTypeCacheSize</a></td></tr>
<tr><td></td><td></td><td>6.9&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_columnTypeModifier" title="Chapter in CDO Model Repository Documentation">Property columnTypeModifier</a></td></tr>
<tr><td></td><td></td><td>6.10&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_forceIndexes" title="Chapter in CDO Model Repository Documentation">Property forceIndexes</a></td></tr>
+<tr><td></td><td></td><td>6.11&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_withRanges" title="Chapter in CDO Model Repository Documentation">Property withRanges</a></td></tr>
+<tr><td></td><td></td><td>6.12&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_copyOnBranch" title="Chapter in CDO Model Repository Documentation">Property copyOnBranch</a></td></tr>
+<tr><td></td><td></td><td>6.13&nbsp;</td><td colspan="3"><a href="Doc01_ConfiguringRepositories.html#Property_forceZeroBasedIndex" title="Chapter in CDO Model Repository Documentation">Property forceZeroBasedIndex</a></td></tr>
<tr><td></td><td>7&nbsp;</td><td colspan="4"><a href="Doc01_ConfiguringRepositories.html#Element_dbAdapter" title="Chapter in CDO Model Repository Documentation">Element dbAdapter</a></td></tr>
<tr><td></td><td>8&nbsp;</td><td colspan="4"><a href="Doc01_ConfiguringRepositories.html#Element_dataSource" title="Chapter in CDO Model Repository Documentation">Element dataSource</a></td></tr>
<tr><td><img src="../../images/article.gif">&nbsp;</td><td colspan="5"><a href="Doc02_ConfiguringAcceptors.html" title="Article in CDO Model Repository Documentation">Configuring Acceptors</a></td></tr>
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc01_ConfiguringRepositories.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc01_ConfiguringRepositories.java
index e32c3f0eb5..9a9897018b 100644
--- a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc01_ConfiguringRepositories.java
+++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/operators/Doc01_ConfiguringRepositories.java
@@ -10,6 +10,10 @@
*/
package org.eclipse.emf.cdo.doc.operators;
+import org.eclipse.emf.cdo.common.branch.CDOBranch;
+import org.eclipse.emf.cdo.common.revision.CDORevision;
+import org.eclipse.emf.cdo.doc.operators.Doc01_ConfiguringRepositories.Element_repository.Property_supportingAudits;
+import org.eclipse.emf.cdo.doc.operators.Doc01_ConfiguringRepositories.Element_repository.Property_supportingBranches;
import org.eclipse.emf.cdo.doc.users.Doc09_TechnicalBackground.Doc_BackgroundModelElements.Doc_BackgroundLegacyModels;
import org.eclipse.emf.cdo.server.IRepository;
import org.eclipse.emf.cdo.server.IStore;
@@ -19,6 +23,8 @@ import org.eclipse.emf.cdo.server.db.mapping.IMappingStrategy;
import org.eclipse.net4j.db.IDBAdapter;
import org.eclipse.net4j.db.ddl.IDBField;
+import org.eclipse.emf.ecore.EStructuralFeature;
+
import javax.sql.DataSource;
/**
@@ -387,6 +393,63 @@ public class Doc01_ConfiguringRepositories
public class Property_forceIndexes
{
}
+
+ /**
+ * Property withRanges
+ * <p>
+ * Specifies whether new {@link CDORevision revisions} create entire new copies of all their list {@link EStructuralFeature features}
+ * or whether just the list deltas are stored.
+ * <p>
+ * Possible configuration values are:
+ * <ul>
+ * <li> <code>false</code> (store new copies of all lists of a revision; default value)
+ * <li> <code>true</code> (store only list deltas/ranges of a revision)
+ * </ul>
+ * <p>
+ * This property is only applicable to horizontal mapping strategies in {@link Property_supportingAudits auditing}
+ * or {@link Property_supportingBranches branching} repositories.
+ */
+ public class Property_withRanges
+ {
+ }
+
+ /**
+ * Property copyOnBranch
+ * <p>
+ * Specifies whether <b>the first</b> new {@link CDORevision revisions} in a {@link CDOBranch branch} create entire new copies
+ * of all their list {@link EStructuralFeature features} or whether just the list deltas (relative to the base revisions in the parent branch) are stored.
+ * <p>
+ * Possible configuration values are:
+ * <ul>
+ * <li> <code>false</code> (store only list deltas/ranges of the first revision in a branch; default value)
+ * <li> <code>true</code> (store new copies of all lists of the first revision in a branch)
+ * </ul>
+ * <p>
+ * This property is only applicable to {@link Property_withRanges range-based} horizontal mapping strategies in
+ * {@link Property_supportingBranches branching} repositories.
+ */
+ public class Property_copyOnBranch
+ {
+ }
+
+ /**
+ * Property forceZeroBasedIndex
+ * <p>
+ * Specifies whether element removals from the beginning of list {@link EStructuralFeature features} adjust the
+ * list indexes of all following elements or whether the first element is allowed to have a non-zero list index.
+ * <p>
+ * Possible configuration values are:
+ * <ul>
+ * <li> <code>false</code> (allow non-zero list index for the first list elements; default value)
+ * <li> <code>true</code> (force zero list indexes for the first list elements)
+ * </ul>
+ * <p>
+ * This property is only applicable to {@link Property_withRanges range-based} horizontal mapping strategies in
+ * {@link Property_supportingAudits auditing} or {@link Property_supportingBranches branching} repositories.
+ */
+ public class Property_forceZeroBasedIndex
+ {
+ }
}
/**

Back to the top