mirrors
/
fop
mirror of https://github.com/apache/fop.git
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 48 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1848 Commits
70 Branches
Tree: 807819bf42
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '807819bf42'
${ noResults }
fop/src/documentation/content/design/alt.design/properties/FOAttributes.html

FOAttributes.html 31KB
Raw Blame History

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

  2. <!-- Created by htmlize-0.67 in css mode. -->

  3. <html>

  4.   <head>

  5.     <title>FOAttributes.java</title>

  6.     <style type="text/css">

  7.     <!--

  8.       body {

  9.         color: #000000;

  10.         background-color: #faf0e6;

  11.       } /* default */

  12.       .jde-java-font-lock-number {

  13.         color: #bc8f8f;

  14.         background-color: #faf0e6;

  15.       } /* jde-java-font-lock-number-face */

  16.       .function-name {

  17.         color: #8b2323;

  18.         background-color: #faf0e6;

  19.       } /* font-lock-function-name-face */

  20.       .jde-java-font-lock-italic {

  21.         background-color: #faf0e6;

  22.         font-style: italic;

  23.       } /* jde-java-font-lock-italic-face */

  24.       .jde-java-font-lock-modifier {

  25.         color: #da70d6;

  26.         background-color: #faf0e6;

  27.       } /* jde-java-font-lock-modifier-face */

  28.       .keyword {

  29.         color: #8b0000;

  30.         background-color: #faf0e6;

  31.       } /* font-lock-keyword-face */

  32.       .variable-name {

  33.         color: #8b008b;

  34.         background-color: #faf0e6;

  35.       } /* font-lock-variable-name-face */

  36.       .string {

  37.         color: #008b00;

  38.         background-color: #faf0e6;

  39.       } /* font-lock-string-face */

  40.       .jde-java-font-lock-package {

  41.         color: #0000cd;

  42.         background-color: #faf0e6;

  43.       } /* jde-java-font-lock-package-face */

  44.       .jde-java-font-lock-constant {

  45.         color: #5f9ea0;

  46.         background-color: #faf0e6;

  47.       } /* jde-java-font-lock-constant-face */

  48.       .type {

  49.         color: #4682b4;

  50.         background-color: #faf0e6;

  51.       } /* font-lock-type-face */

  52.       .jde-java-font-lock-doc-tag {

  53.         color: #008b00;

  54.         background-color: #faf0e6;

  55.       } /* jde-java-font-lock-doc-tag-face */

  56.       .comment {

  57.         color: #00008b;

  58.         background-color: #faf0e6;

  59.       } /* font-lock-comment-face */

  60.       .reference {

  61.         color: #cd0000;

  62.         background-color: #faf0e6;

  63.       } /* font-lock-reference-face */

  64.       a {

  65.         color: inherit;

  66.         background-color: inherit;

  67.         font: inherit;

  68.         text-decoration: inherit;

  69.       }

  70.       a:hover {

  71.         text-decoration: underline;

  72.       }

  73.     -->

  74.     </style>

  75.   </head>

  76.   <body>

  77.     <pre>

  78. <span class="keyword">package</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">fo</span>;

  79. 

  80. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">apps</span>.<span class="type">FOPException</span>;

  81. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">fo</span>.<span class="jde-java-font-lock-package">expr</span>.<span class="type">PropertyException</span>;

  82. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">fo</span>.<span class="type">PropertyConsts</span>;

  83. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">fo</span>.<span class="type">FObjectNames</span>;

  84. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">datatypes</span>.<span class="type">Ints</span>;

  85. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">messaging</span>.<span class="type">MessageHandler</span>;

  86. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">xml</span>.<span class="type">FoXMLEvent</span>;

  87. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">xml</span>.<span class="type">XMLNamespaces</span>;

  88. 

  89. <span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">xml</span>.<span class="jde-java-font-lock-package">sax</span>.<span class="type">Attributes</span>;

  90. 

  91. <span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">Iterator</span>;

  92. <span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">ArrayList</span>;

  93. <span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">HashMap</span>;

  94. <span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">List</span>;

  95. <span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">Map</span>;

  96. <span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">Collections</span>;

  97. <span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">Arrays</span>;

  98. 

  99. <span class="comment">/*

  100.  * FOAttributes.java

  101.  * $Id$

  102.  *

  103.  * Created: Wed Nov 14 15:19:51 2001

  104.  * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.

  105.  * For details on use and redistribution please refer to the

  106.  * LICENSE file included with these sources.

  107.  *

  108.  * @author &lt;a href=&quot;mailto:pbwest@powerup.com.au&quot;&gt;Peter B. West&lt;/a&gt;

  109.  * @version $Revision$ $Name$

  110.  */</span>

  111. <span class="comment">/**

  112.  * The FO Attributes data structures and methods needed to manage the

  113.  * Attributes associated with FO nodes.

  114.  */</span>

  115. 

  116. <span class="jde-java-font-lock-modifier">public</span> <span class="keyword">class</span> <span class="function-name" id="FOAttributesClass">FOAttributes</span> {

  117. 

  118.     <span class="jde-java-font-lock-modifier">private</span> <span class="jde-java-font-lock-modifier">static</span> <span class="jde-java-font-lock-modifier">final</span> <span class="type">String</span> <span class="variable-name" id="tag">tag</span> = &quot;<span class="string">$Name$</span>&quot;;

  119.     <span class="jde-java-font-lock-modifier">private</span> <span class="jde-java-font-lock-modifier">static</span> <span class="jde-java-font-lock-modifier">final</span> <span class="type">String</span> <span class="variable-name" id="revision">revision</span> = &quot;<span class="string">$Revision$</span>&quot;;

  120. 

  121.     <span class="comment">/**

  122.      * &lt;i&gt;</span><span class="jde-java-font-lock-italic">nSpaceAttrMaps</span><span class="comment">&lt;/i&gt; is an &lt;tt&gt;ArrayList&lt;/tt&gt; to hold the array of 

  123.      * &lt;tt&gt;HashMap&lt;/tt&gt;s which contain the attribute lists for each

  124.      * namespace which may be active for a particular FO element.  The

  125.      * &lt;tt&gt;ArrayList&lt;/tt&gt; is indexed by the URIIndex for this namespace

  126.      * which is maintained in an &lt;tt&gt;XMLNamespaces&lt;/tt&gt; object by the

  127.      * &lt;tt&gt;FOTree&lt;/tt&gt; object which is processing the FO input.  The

  128.      * values in the &lt;tt&gt;HashMap&lt;/tt&gt;s are indexed by the local name of the

  129.      * attribute.

  130.      * The &lt;tt&gt;ArrayList&lt;/tt&gt; will not be created for a particular instance

  131.      * of &lt;tt&gt;FOAttributes&lt;/tt&gt; unless a namespace other than the standard

  132.      * XSL namespace is activated for this instance.

  133.      * See &lt;i&gt;</span><span class="jde-java-font-lock-italic">foAttrMap</span><span class="comment">&lt;/i&gt;.

  134.      */</span>

  135.     <span class="jde-java-font-lock-modifier">private</span> <span class="type">ArrayList</span> <span class="variable-name" id="nSpaceAttrMaps">nSpaceAttrMaps</span>;

  136. 

  137.     <span class="comment">/**

  138.      * &lt;i&gt;</span><span class="jde-java-font-lock-italic">foAttrMap</span><span class="comment">&lt;/i&gt; is a &lt;tt&gt;HashMap&lt;/tt&gt; to hold the FO namespace

  139.      * attribute list specified in the FO element with which this list is

  140.      * associated.  The &lt;tt&gt;String&lt;/tt&gt; attribute value is stored

  141.      * indexed by the integer constant property identifier from

  142.      * &lt;tt&gt;PropertyConsts&lt;/tt&gt;.

  143.      */</span>

  144.     <span class="jde-java-font-lock-modifier">private</span> <span class="type">HashMap</span> <span class="variable-name" id="foAttrMap">foAttrMap</span> = <span class="keyword">new</span> <span class="type">HashMap</span>(<span class="jde-java-font-lock-number">0</span>);

  145. 

  146.     <span class="comment">/**

  147.      * A sorted array of the keys (property indices) of the values in

  148.      * &lt;i&gt;</span><span class="jde-java-font-lock-italic">foAttrMap</span><span class="comment">&lt;/i&gt;.

  149.      */</span>

  150.     <span class="jde-java-font-lock-modifier">private</span> <span class="type">Integer</span>[] <span class="variable-name" id="foAttrKeys">foAttrKeys</span> = <span class="jde-java-font-lock-constant" id="null">null</span>;

  151. 

  152.     <span class="comment">/**

  153.      * A static array of &lt;tt&gt;Integer&lt;/tt&gt; as a template for the generation

  154.      * of the &lt;i&gt;</span><span class="jde-java-font-lock-italic">foAttrKeys</span><span class="comment">&lt;/i&gt; array.

  155.      */</span>

  156.     <span class="jde-java-font-lock-modifier">private</span> <span class="jde-java-font-lock-modifier">static</span> <span class="type">Integer</span>[] <span class="variable-name" id="integerArray">integerArray</span>

  157.                                     = <span class="keyword">new</span> <span class="type">Integer</span>[] { Ints.consts.get(<span class="jde-java-font-lock-number">0</span>) };

  158. 

  159.     <span class="comment">/**

  160.      * Construct an &lt;i&gt;</span><span class="jde-java-font-lock-italic">FOAttributes</span><span class="comment">&lt;/i&gt; object.

  161.      * &lt;p&gt;The &lt;tt&gt;Attributes&lt;/tt&gt; object on the event is scanned, and each

  162.      * attribute is examined.  If the attribute is in the default namespace

  163.      * for fo: attributes, it is an fo: property, and its value is entered

  164.      * into the &lt;i&gt;</span><span class="jde-java-font-lock-italic">foAttrMap</span><span class="comment">&lt;/i&gt; &lt;tt&gt;Hashmap&lt;/tt&gt; indexed by the property

  165.      * index.

  166.      * &lt;p&gt;If the attribute does not belong to the default namespace, its

  167.      * value is entered into the appropriate &lt;tt&gt;HashMap&lt;/tt&gt; in the

  168.      * &lt;tt&gt;ArrayList&lt;/tt&gt; &lt;i&gt;</span><span class="jde-java-font-lock-italic">nSpaceAttrMaps</span><span class="comment">&lt;/i&gt;, indexed by the attribute's

  169.      * local name.

  170.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="event">event</span><span class="comment"> - the FO XML event which triggered construction of the

  171.      * parent &lt;tt&gt;FONode&lt;/tt&gt;.

  172.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="foNode">foNode</span><span class="comment"> - the &lt;tt&gt;FONode&lt;/tt&gt; with which these attributes are

  173.      * associated.

  174.      */</span>

  175.     <span class="jde-java-font-lock-modifier">public</span> <span class="function-name" id="FOAttributes">FOAttributes</span>(<span class="type">FoXMLEvent</span> <span class="variable-name">event</span>, <span class="type">FONode</span> <span class="variable-name">foNode</span>) <span class="keyword">throws</span> <span class="type">FOPException</span> {

  176. 

  177.         <span class="comment">// If the event is null, there is no event associated with this

  178. </span>        <span class="comment">// node, probably because this is a manufactured node; e.g.,

  179. </span>        <span class="comment">// an &quot;invented&quot; FopageSequenceMaster.  The default initialisation

  180. </span>        <span class="comment">// includes an empty foAttrMap HashMap.

  181. </span>        <span class="keyword">if</span> (event == <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span>;

  182. 

  183.         <span class="keyword">if</span> (event.getFoType() == FObjectNames.<span class="jde-java-font-lock-constant" id="PCDATA">PCDATA</span>)

  184.             <span class="keyword">return</span>;  <span class="comment">// go with the empty foAttrMap

  185. </span>

  186.         <span class="comment">// Create the foAttrMap.

  187. </span>        <span class="type">Attributes</span> <span class="variable-name" id="attributes">attributes</span> = event.getAttributes();

  188.         <span class="keyword">if</span> (attributes == <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">FOPException</span>

  189.                                        (&quot;<span class="string">No Attributes in XMLEvent</span>&quot;);

  190.         <span class="type">int</span> <span class="variable-name" id="propIndex">propIndex</span>;

  191.         <span class="type">HashMap</span> <span class="variable-name" id="tmpHash">tmpHash</span>;

  192.         <span class="keyword">for</span> (<span class="type">int</span> <span class="variable-name" id="i">i</span> = <span class="jde-java-font-lock-number">0</span>; i &lt; attributes.getLength(); i++) {

  193.             <span class="type">String</span> <span class="variable-name" id="attrUri">attrUri</span> = attributes.getURI(i);

  194.             <span class="type">String</span> <span class="variable-name" id="attrLocalname">attrLocalname</span> = attributes.getLocalName(i);

  195.             <span class="type">String</span> <span class="variable-name" id="attrQName">attrQName</span> = attributes.getQName(i);

  196.             <span class="type">int</span> <span class="variable-name" id="sep">sep</span> = attrQName.indexOf('<span class="string">:</span>');

  197.             <span class="type">String</span> <span class="variable-name" id="prefix">prefix</span> = attrQName.substring(<span class="jde-java-font-lock-number">0</span>, (sep == -<span class="jde-java-font-lock-number">1</span> ? <span class="jde-java-font-lock-number">0</span> : sep));

  198.             <span class="keyword">if</span> (prefix.equals(&quot;<span class="string">xmlns</span>&quot;)) <span class="keyword">break</span>;

  199.             <span class="type">String</span> <span class="variable-name" id="attrValue">attrValue</span> = attributes.getValue(i);

  200.             <span class="type">int</span> <span class="variable-name" id="attrUriIndex">attrUriIndex</span> = foNode.namespaces.getURIIndex(attrUri);

  201. 

  202.             <span class="comment">//System.out.println(&quot;FONode:&quot; + event);

  203. </span>            <span class="keyword">if</span> (attrUriIndex == XMLNamespaces.DefAttrNSIndex) {

  204.                 <span class="comment">// Standard FO namespace

  205. </span>                <span class="comment">// Catch default namespace declaration here.

  206. </span>                <span class="keyword">if</span> (attrLocalname.equals(&quot;<span class="string">xmlns</span>&quot;)) <span class="keyword">break</span>;

  207.                 <span class="comment">// Is this a known (valid) property?

  208. </span>                propIndex = PropNames.getPropertyIndex(attrLocalname);

  209.                     <span class="comment">// Known attribute name

  210. </span>                foAttrMap.put(Ints.consts.get(propIndex), attrValue);

  211.             } <span class="keyword">else</span> { <span class="comment">// Not the XSL FO namespace

  212. </span>                <span class="type">int</span> <span class="variable-name" id="j">j</span>;

  213.                 <span class="keyword">if</span> (nSpaceAttrMaps == <span class="jde-java-font-lock-constant">null</span>) {

  214.                     <span class="comment">//Create the list

  215. </span>                    System.out.println(&quot;<span class="string">Creating nSpaceAttrMaps</span>&quot;);

  216.                     nSpaceAttrMaps = <span class="keyword">new</span> <span class="type">ArrayList</span>(attrUriIndex + <span class="jde-java-font-lock-number">1</span>);

  217.                     <span class="comment">// Add the fo list

  218. </span>                    <span class="keyword">for</span> (j = <span class="jde-java-font-lock-number">0</span>; j &lt; XMLNamespaces.DefAttrNSIndex; j++)

  219.                         nSpaceAttrMaps.add(<span class="keyword">new</span> <span class="type">HashMap</span>(<span class="jde-java-font-lock-number">0</span>));

  220. 

  221.                     System.out.println(&quot;<span class="string">Adding foAttrMap</span>&quot;);

  222.                     nSpaceAttrMaps.add(foAttrMap);

  223.                 }

  224.                 <span class="comment">// Make sure there are elements between the last current

  225. </span>                <span class="comment">// and the one to be added

  226. </span>                <span class="keyword">for</span> (j = nSpaceAttrMaps.size(); j &lt;= attrUriIndex; j++)

  227.                     nSpaceAttrMaps.add(<span class="keyword">new</span> <span class="type">HashMap</span>(<span class="jde-java-font-lock-number">0</span>));

  228.                 

  229.                 <span class="comment">// Does a HashMap exist for this namespace?

  230. </span>                <span class="keyword">if</span> ((tmpHash =

  231.                      (<span class="type">HashMap</span>)nSpaceAttrMaps.get(attrUriIndex)) == <span class="jde-java-font-lock-constant">null</span>) {

  232.                     tmpHash = <span class="keyword">new</span> <span class="type">HashMap</span>(<span class="jde-java-font-lock-number">1</span>);

  233.                     nSpaceAttrMaps.set(attrUriIndex, tmpHash);

  234.                 }

  235.                 <span class="comment">// Now put this value in the HashMap

  236. </span>                tmpHash.put(attrLocalname, attrValue);

  237.             }

  238.         }

  239.         <span class="comment">// Set up the sorted array of the foAttr keys, if foAttrMap has

  240. </span>        <span class="comment">// any entries.

  241. </span>        <span class="keyword">if</span> (foAttrMap.size() &gt; <span class="jde-java-font-lock-number">0</span>) {

  242.             foAttrKeys = (<span class="type">Integer</span>[])(foAttrMap.keySet().toArray(integerArray));

  243.             Arrays.sort(foAttrKeys);

  244.         }

  245.         <span class="comment">// Finished with the Attributes object

  246. </span>        event.setAttributes(<span class="jde-java-font-lock-constant">null</span>);

  247.     }

  248. 

  249.     <span class="comment">/**

  250.      * Get the default namespace attribute values as an unmodifiable

  251.      * &lt;tt&gt;Map&lt;/tt&gt;.

  252.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a unmodifiable &lt;tt&gt;Map&lt;/tt&gt; containing the the attribute

  253.      * values for all of the default attribute namespace attributes in this

  254.      * attribute list, indexed by the property name index from

  255.      * &lt;tt&gt;PropNames&lt;/tt&gt;.

  256.      */</span>

  257.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">Map</span> <span class="function-name" id="getFixedFoAttrMap">getFixedFoAttrMap</span>() {

  258.         <span class="keyword">return</span> Collections.unmodifiableMap((<span class="type">Map</span>)foAttrMap);

  259.     }

  260. 

  261.     <span class="comment">/**

  262.      * Get the &lt;tt&gt;HashMap&lt;/tt&gt; of all default namespace attributes.

  263.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> &lt;tt&gt;HashMap&lt;/tt&gt; &lt;i&gt;</span><span class="jde-java-font-lock-italic">foAttrMap</span><span class="comment">&lt;/i&gt; containing the the attribute

  264.      * values for all of the default attribute namespace attributes in this

  265.      * attribute list, indexed by the property name index from

  266.      * &lt;tt&gt;PropNames&lt;/tt&gt;.  This HashMap may be changed by the calling

  267.      * process.

  268.      */</span>

  269.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">HashMap</span> <span class="function-name" id="getFoAttrMap">getFoAttrMap</span>() {

  270.         <span class="keyword">return</span> foAttrMap;

  271.     }

  272. 

  273.     <span class="comment">/**

  274.      * Get the sorted array of property index keys for the default namespace

  275.      * attributes.

  276.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> &lt;tt&gt;Integer[]&lt;/tt&gt; &lt;i&gt;</span><span class="jde-java-font-lock-italic">foAttrKeys</span><span class="comment">&lt;/i&gt; containing the the

  277.      * sorted keys (the property indices from &lt;tt&gt;PropNames&lt;/tt&gt;) of the

  278.      * attribute values for all of the default attribute namespace attributes

  279.      * in this attribute list.

  280.      * Warning: This array may be changed by the calling process.

  281.      */</span>

  282.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">Integer</span>[] <span class="function-name" id="getFoAttrKeys">getFoAttrKeys</span>() {

  283.         <span class="keyword">return</span> foAttrKeys;

  284.     }

  285. 

  286.     <span class="comment">/**

  287.      * A convenience method for accessing attribute values from the default

  288.      * attribute namespace.

  289.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="property">property</span><span class="comment"> an &lt;tt&gt;int&lt;/tt&gt; containing the property name index

  290.      * from &lt;tt&gt;PropNames&lt;/tt&gt;.

  291.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a &lt;tt&gt;String&lt;/tt&gt; containing the associated property value.

  292.      */</span>

  293.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">String</span> <span class="function-name" id="getFoAttrValue">getFoAttrValue</span>(<span class="type">int</span> <span class="variable-name">property</span>) {

  294.         <span class="keyword">return</span> (<span class="type">String</span>)(foAttrMap.get(Ints.consts.get(property)));

  295.     }

  296. 

  297.     <span class="comment">/**

  298.      * A convenience method for accessing attribute values from the default

  299.      * attribute namespace.

  300.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="propertyName">propertyName</span><span class="comment"> a &lt;tt&gt;String&lt;/tt&gt; containing the property name.

  301.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a &lt;tt&gt;String&lt;/tt&gt; containing the associated property value.

  302.      */</span>

  303.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">String</span> <span class="function-name">getFoAttrValue</span>(<span class="type">String</span> <span class="variable-name">propertyName</span>)

  304.         <span class="keyword">throws</span> <span class="type">PropertyException</span>

  305.     {

  306.         <span class="keyword">return</span> getFoAttrValue(PropNames.getPropertyIndex(propertyName));

  307.     }

  308. 

  309.     <span class="comment">/**

  310.      * Get an unmodifiable &lt;tt&gt;Map&lt;/tt&gt; of the attribute values for a

  311.      * particular namespace.

  312.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="uriIndex">uriIndex</span><span class="comment"> an &lt;tt&gt;int&lt;/tt&gt; containing the index of the attribute

  313.      * values namespace, maintained in an &lt;tt&gt;XMLEvent&lt;/tt&gt; &lt;tt&gt;static&lt;/tt&gt;

  314.      * array.

  315.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an unmodifiable &lt;tt&gt;Map&lt;/tt&gt; of the attribute values

  316.      * within the indexed namespace, for this attribute list, indexed by the

  317.      * local name of the attribute.  The &lt;tt&gt;Map&lt;/tt&gt; returned is

  318.      * derived from the one maintained in &lt;i&gt;</span><span class="jde-java-font-lock-italic">nSpaceAttrMaps</span><span class="comment">&lt;/i&gt;.

  319.      */</span>

  320.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">Map</span> <span class="function-name" id="getAttrMap">getAttrMap</span>(<span class="type">int</span> <span class="variable-name">uriIndex</span>) {

  321.         <span class="keyword">if</span> (uriIndex == XMLNamespaces.DefAttrNSIndex)

  322.             <span class="keyword">return</span> Collections.unmodifiableMap((<span class="type">Map</span>)foAttrMap);

  323.         <span class="keyword">if</span> (nSpaceAttrMaps != <span class="jde-java-font-lock-constant">null</span>) {

  324.             <span class="keyword">if</span> (uriIndex &gt;= nSpaceAttrMaps.size()) <span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;

  325.             <span class="keyword">return</span> Collections.unmodifiableMap

  326.                     ((<span class="type">Map</span>)(nSpaceAttrMaps.get(uriIndex)));

  327.         } <span class="keyword">else</span> {

  328.             <span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;

  329.         }

  330.     }

  331. 

  332.     <span class="comment">/**

  333.      * Get the value of an attribute in a particular namespace.

  334.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">uriIndex</span><span class="comment"> an &lt;tt&gt;int&lt;/tt&gt; index of the URIs maintained

  335.      * by &lt;tt&gt;XMLEvent&lt;/tt&gt;.

  336.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="localName">localName</span><span class="comment"> a &lt;tt&gt;String&lt;/tt&gt; with the local name of the

  337.      * attribute.  In the case of the default attribute namespace, this

  338.      * will be the fo property name.

  339.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a &lt;tt&gt;String&lt;/tt&gt; containing the value of the attribute.

  340.      */</span>

  341.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">String</span> <span class="function-name" id="getUriAttrValue">getUriAttrValue</span>(<span class="type">int</span> <span class="variable-name">uriIndex</span>, <span class="type">String</span> <span class="variable-name">localName</span>)

  342.         <span class="keyword">throws</span> <span class="type">PropertyException</span>

  343.     {

  344.         <span class="keyword">if</span> (uriIndex == XMLNamespaces.DefAttrNSIndex)

  345.             <span class="keyword">return</span> getFoAttrValue(PropNames.getPropertyIndex(localName));

  346.         <span class="keyword">return</span> (String)

  347.                 (((<span class="type">HashMap</span>)nSpaceAttrMaps.get(uriIndex)).get(localName));

  348.     }

  349. 

  350.     <span class="comment">/**

  351.      * Get the size of the &lt;i&gt;</span><span class="jde-java-font-lock-italic">foAttrMap</span><span class="comment">&lt;/i&gt; &lt;tt&gt;HashMap&lt;/tt&gt;

  352.      * containing attributes for the default fo: namespace

  353.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an &lt;tt&gt;int&lt;/tt&gt; containing the size.

  354.      */</span>

  355.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">int</span> <span class="function-name" id="getFoAttrMapSize">getFoAttrMapSize</span>() {

  356.         <span class="keyword">return</span> foAttrMap.size();

  357.     }

  358. 

  359.     <span class="comment">/**

  360.      * Get the size of the &lt;i&gt;</span><span class="jde-java-font-lock-italic">nSpaceAttrMaps</span><span class="comment">&lt;/i&gt; &lt;tt&gt;ArrayList&lt;/tt&gt;

  361.      * containing attribute namespaces active in this set of attributes.

  362.      * &lt;i&gt;</span><span class="jde-java-font-lock-italic">N.B.</span><span class="comment">&lt;/i&gt; this may be zero if only the default attribute

  363.      * namespace has been seen in the attribute set.

  364.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an &lt;tt&gt;int&lt;/tt&gt; containing the size.

  365.      */</span>

  366.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">int</span> <span class="function-name" id="getNSpaceAttrMapsSize">getNSpaceAttrMapsSize</span>() {

  367.         <span class="keyword">if</span> (nSpaceAttrMaps == <span class="jde-java-font-lock-constant">null</span>)

  368.             <span class="keyword">return</span> <span class="jde-java-font-lock-number">0</span>;

  369.         <span class="keyword">return</span> nSpaceAttrMaps.size();

  370.     }

  371. 

  372.     <span class="comment">/**

  373.      * Merge attributes from another &lt;tt&gt;FOAttributes&lt;/tt&gt; into &lt;i&gt;</span><span class="jde-java-font-lock-italic">this</span><span class="comment">&lt;/i&gt;.

  374.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="foAttrs">foAttrs</span><span class="comment"> the &lt;tt&gt;FOAttributes&lt;/tt&gt; containing the attributes

  375.      * to merge.

  376.      */</span>

  377.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">void</span> <span class="function-name" id="merge">merge</span>(<span class="type">FOAttributes</span> <span class="variable-name">foAttrs</span>) {

  378.         foAttrMap.putAll(foAttrs.getFoAttrMap());

  379.         <span class="type">int</span> <span class="variable-name" id="attrLen">attrLen</span> = foAttrs.getNSpaceAttrMapsSize();

  380.         <span class="keyword">if</span> (attrLen != <span class="jde-java-font-lock-number">0</span>) {

  381.             <span class="comment">// something to copy

  382. </span>            <span class="keyword">if</span> (nSpaceAttrMaps == <span class="jde-java-font-lock-constant">null</span>) {

  383.                 <span class="comment">// no &quot;foreign&quot; attribute lists in this

  384. </span>                <span class="comment">// copy the others in

  385. </span>                nSpaceAttrMaps = <span class="keyword">new</span> <span class="type">ArrayList</span>(attrLen);

  386.             }

  387.             <span class="comment">// If the merging ArrayList of namespaces is larger, add the

  388. </span>            <span class="comment">// extra elements and initialise each to an empty HashMap

  389. </span>            <span class="keyword">for</span> (<span class="type">int</span> <span class="variable-name">i</span> = nSpaceAttrMaps.size(); i &lt; attrLen; i++)

  390.                 nSpaceAttrMaps.add(<span class="keyword">new</span> <span class="type">HashMap</span>(<span class="jde-java-font-lock-number">0</span>));

  391.             <span class="comment">// Except for foAttrs, which has already been merged, merge

  392. </span>            <span class="comment">// the entries from the merging foAttrs

  393. </span>            <span class="keyword">for</span> (<span class="type">int</span> <span class="variable-name">i</span> = <span class="jde-java-font-lock-number">0</span>; i &lt; attrLen; i++) {

  394.                 <span class="comment">// skip foAttrMap

  395. </span>                <span class="keyword">if</span> (i == <span class="reference">XMLNamespaces</span>.<span class="type">DefAttrNSIndex</span>) <span class="keyword">continue</span>;

  396.                ((<span class="type">HashMap</span>) nSpaceAttrMaps.get(i))

  397.                        .putAll(foAttrs.getAttrMap(i));

  398.             }

  399.         }

  400.     }

  401. 

  402. }<span class="comment">// FOAttributes

  403. </span></pre>

  404.   </body>

  405. </html>