001: /*
002: * $Id: XmlPeer.java 2366 2006-09-14 23:10:58Z xlv $
003: * $Name$
004: *
005: * Copyright 2001, 2002 by Bruno Lowagie.
006: *
007: * The contents of this file are subject to the Mozilla Public License Version 1.1
008: * (the "License"); you may not use this file except in compliance with the License.
009: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
010: *
011: * Software distributed under the License is distributed on an "AS IS" basis,
012: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
013: * for the specific language governing rights and limitations under the License.
014: *
015: * The Original Code is 'iText, a free JAVA-PDF library'.
016: *
017: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
018: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
019: * All Rights Reserved.
020: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
021: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
022: *
023: * Contributor(s): all the names of the contributors are added in the source code
024: * where applicable.
025: *
026: * Alternatively, the contents of this file may be used under the terms of the
027: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
028: * provisions of LGPL are applicable instead of those above. If you wish to
029: * allow use of your version of this file only under the terms of the LGPL
030: * License and not to allow others to use your version of this file under
031: * the MPL, indicate your decision by deleting the provisions above and
032: * replace them with the notice and other provisions required by the LGPL.
033: * If you do not delete the provisions above, a recipient may use your version
034: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
035: *
036: * This library is free software; you can redistribute it and/or modify it
037: * under the terms of the MPL as stated above or under the terms of the GNU
038: * Library General Public License as published by the Free Software Foundation;
039: * either version 2 of the License, or any later version.
040: *
041: * This library is distributed in the hope that it will be useful, but WITHOUT
042: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
043: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
044: * details.
045: *
046: * If you didn't download this code from the following link, you should check if
047: * you aren't using an obsolete version:
048: * http://www.lowagie.com/iText/
049: */
050:
051: package com.lowagie.text.xml;
052:
053: import java.util.Properties;
054:
055: import org.xml.sax.Attributes;
056:
057: import com.lowagie.text.ElementTags;
058:
059: /**
060: * This interface is implemented by the peer of all the iText objects.
061: */
062:
063: public class XmlPeer {
064:
065: /** This is the name of the alias. */
066: protected String tagname;
067:
068: /** This is the name of the alias. */
069: protected String customTagname;
070:
071: /** This is the Map that contains the aliases of the attributes. */
072: protected Properties attributeAliases = new Properties();
073:
074: /** This is the Map that contains the default values of the attributes. */
075: protected Properties attributeValues = new Properties();
076:
077: /** This is String that contains the default content of the attributes. */
078: protected String defaultContent = null;
079:
080: /**
081: * Creates a XmlPeer.
082: * @param name the iText name of a tag
083: * @param alias the userdefined name of a tag
084: */
085:
086: public XmlPeer(String name, String alias) {
087: this .tagname = name;
088: this .customTagname = alias;
089: }
090:
091: /**
092: * Gets the tagname of the peer.
093: * @return the iText name of a tag
094: */
095:
096: public String getTag() {
097: return tagname;
098: }
099:
100: /**
101: * Gets the tagname of the peer.
102: * @return the userdefined tagname
103: */
104:
105: public String 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 getAttributes(Attributes attrs) {
114: Properties attributes = new Properties();
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 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 name, String 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 name, String 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 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 getName(String name) {
168: String 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 getDefaultValues() {
181: return attributeValues;
182: }
183: }
|