KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > xml > XmlPeer


1 /*
2  * $Id: XmlPeer.java 2366 2006-09-14 23:10:58Z xlv $
3  * $Name$
4  *
5  * Copyright 2001, 2002 by Bruno Lowagie.
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text.xml;
52
53 import java.util.Properties JavaDoc;
54
55 import org.xml.sax.Attributes JavaDoc;
56
57 import com.lowagie.text.ElementTags;
58
59 /**
60  * This interface is implemented by the peer of all the iText objects.
61  */
62
63 public class XmlPeer {
64     
65 /** This is the name of the alias. */
66     protected String JavaDoc tagname;
67     
68 /** This is the name of the alias. */
69     protected String JavaDoc customTagname;
70     
71 /** This is the Map that contains the aliases of the attributes. */
72     protected Properties JavaDoc attributeAliases = new Properties JavaDoc();
73     
74 /** This is the Map that contains the default values of the attributes. */
75     protected Properties JavaDoc attributeValues = new Properties JavaDoc();
76     
77 /** This is String that contains the default content of the attributes. */
78     protected String JavaDoc defaultContent = null;
79     
80 /**
81  * Creates a XmlPeer.
82  * @param name the iText name of a tag
83  * @param alias the userdefined name of a tag
84  */
85     
86     public XmlPeer(String JavaDoc name, String JavaDoc alias) {
87         this.tagname = name;
88         this.customTagname = alias;
89     }
90     
91 /**
92  * Gets the tagname of the peer.
93  * @return the iText name of a tag
94  */
95     
96     public String JavaDoc getTag() {
97         return tagname;
98     }
99     
100 /**
101  * Gets the tagname of the peer.
102  * @return the userdefined tagname
103  */
104     
105     public String JavaDoc getAlias() {
106         return customTagname;
107     }
108     
109 /** Gets the list of attributes of the peer.
110  * @param attrs the userdefined set of attributes
111  * @return the set of attributes translated to iText attributes
112  */
113     public Properties JavaDoc getAttributes(Attributes JavaDoc attrs) {
114         Properties JavaDoc attributes = new Properties JavaDoc();
115         attributes.putAll(attributeValues);
116         if (defaultContent != null) {
117             attributes.put(ElementTags.ITEXT, defaultContent);
118         }
119         if (attrs != null) {
120             for (int i = 0; i < attrs.getLength(); i++) {
121                 String JavaDoc attribute = getName(attrs.getQName(i));
122                 attributes.setProperty(attribute, attrs.getValue(i));
123             }
124         }
125         return attributes;
126     }
127     
128 /**
129  * Sets an alias for an attribute.
130  *
131  * @param name the iText tagname
132  * @param alias the custom tagname
133  */
134     
135     public void addAlias(String JavaDoc name, String JavaDoc alias) {
136         attributeAliases.put(alias, name);
137     }
138     
139 /**
140  * Sets a value for an attribute.
141  *
142  * @param name the iText tagname
143  * @param value the default value for this tag
144  */
145     
146     public void addValue(String JavaDoc name, String JavaDoc value) {
147         attributeValues.put(name, value);
148     }
149     
150 /**
151  * Sets the default content.
152  *
153  * @param content the default content
154  */
155     
156     public void setContent(String JavaDoc content) {
157         this.defaultContent = content;
158     }
159     
160 /**
161  * Returns the iText attribute name.
162  *
163  * @param name the custom attribute name
164  * @return iText translated attribute name
165  */
166     
167     public String JavaDoc getName(String JavaDoc name) {
168         String JavaDoc value;
169         if ((value = attributeAliases.getProperty(name)) != null) {
170             return value;
171         }
172         return name;
173     }
174     
175 /**
176  * Returns the default values.
177  * @return A set of default (userdefined) values
178  */
179     
180     public Properties JavaDoc getDefaultValues() {
181         return attributeValues;
182     }
183 }
Popular Tags