You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2013/06/17 17:48:34 UTC
svn commit: r1493825 - in
/uima/uimaj/trunk/uima-docbook-references/src/docbook: ref.cas.xml
ref.jcas.xml
Author: schor
Date: Mon Jun 17 15:48:33 2013
New Revision: 1493825
URL: http://svn.apache.org/r1493825
Log:
[UIMA-2434] improve docs for bulk removal operations
Modified:
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml?rev=1493825&r1=1493824&r2=1493825&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml Mon Jun 17 15:48:33 2013
@@ -675,12 +675,14 @@ private Feature initFeature(String featN
<listitem><para>add the item back to the indexes, in all views.</para></listitem>
</orderedlist></para>
- <para>There are two methods you can use on index repositories to efficiently bulk-remove all
- instances of particular types of feature structures. One of these,
- <code>removeAllIncludingSubtypes</code> removes all instances of a particular
+ <para>As of version 2.4.1, there are two methods you can use on an index repository
+ to efficiently bulk-remove all
+ instances of particular types of feature structures from a particular view. One of these,
+ <code>aCas.getIndexRepository().removeAllIncludingSubtypes(aType)</code> removes all instances of a particular
type, including instances which are subtypes of the specified type. The other,
- <code>removeAllExcludingSubtypes</code> remove all instances of a particular
- type, only.</para>
+ <code>aCas.getIndexRepository().removeAllExcludingSubtypes(aType)</code> remove all instances of a particular
+ type, only. In both cases, the removal is done from the particular view of the CAS referenced
+ by aCas.</para>
</section>
<section id="ugr.ref.cas.accessing_modifying_features_of_feature_structures">
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml?rev=1493825&r1=1493824&r2=1493825&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml Mon Jun 17 15:48:33 2013
@@ -553,6 +553,19 @@ myView2.addFsToIndexes(myInstance); // i
Otherwise, if the instance was created by any of the Feature Structure Iterator operations over some index,
then it is the view associated with the index.
</para>
+
+ <para>As of release 2.4.1, there are two efficient bulk-remove methods to remove all instances of a given type,
+ or all instances of a given type and its subtypes.
+ These are invoked on an instance of an IndexRepository,
+ for a particular view. For example, to remove instances of Token:
+ </para>
+ <programlisting>jcas.getFsIndexRepository().
+ removeAllIncludingSubtypes(jcas.getCasType(Token.type))
+ or
+jcas.getFsIndexRepository().
+ removeAllExcludingSubtypes(jcas.getCasType(Token.type))
+ </programlisting>
+
</section>
<section id="ugr.ref.jcas.using_iterators">