svn commit: r724474 - /incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml

[sc...@apache.org]

Author: schor
Date: Mon Dec  8 12:40:41 2008
New Revision: 724474

URL: http://svn.apache.org/viewvc?rev=724474&view=rev
Log:
[UIMA-1208] improve docs to say getComponentType doesn't work for FSList

Modified:
    incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml

Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml?rev=724474&r1=724473&r2=724474&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml Mon Dec  8 12:40:41 2008
@@ -341,7 +341,13 @@
         omitted, it defaults to <literal>uima.cas.TOP</literal>, meaning that any
         FeatureStructure can be assigned as an element the array or list. Note: depending on
         the CAS Interface that you use in your code, this constraint may or may not be
-        enforced.</para>
+        enforced.
+        Note: At run time, the elementType is available from a runtime Feature object 
+            (using the <literal>a_feature_object.getRange().getComponentType()</literal> method) 
+            only when specified for the <literal>uima.cas.FSArray</literal> ranges; it isn't
+            available for <literal>uima.cas.FSList</literal> ranges.
+        </para>
+        
       
       <para>The <literal>multipleReferencesAllowed</literal> feature is optional, and
         applies only when the <literal>rangeTypeName</literal> is an array or list type (it