com.lowagie.text.xml.XmlPeer Maven / Gradle / Ivy

Go to download
/*
 * $Id: XmlPeer.java 3373 2008-05-12 16:21:24Z xlv $
 *
 * Copyright 2001, 2002 by Bruno Lowagie.
 *
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the License.
 *
 * The Original Code is 'iText, a free JAVA-PDF library'.
 *
 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
 * All Rights Reserved.
 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
 *
 * Contributor(s): all the names of the contributors are added in the source code
 * where applicable.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
 * provisions of LGPL are applicable instead of those above.  If you wish to
 * allow use of your version of this file only under the terms of the LGPL
 * License and not to allow others to use your version of this file under
 * the MPL, indicate your decision by deleting the provisions above and
 * replace them with the notice and other provisions required by the LGPL.
 * If you do not delete the provisions above, a recipient may use your version
 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the MPL as stated above or under the terms of the GNU
 * Library General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
 * details.
 *
 * If you didn't download this code from the following link, you should check if
 * you aren't using an obsolete version:
 * http://www.lowagie.com/iText/
 */

package com.lowagie.text.xml;

import java.util.Properties;

import org.xml.sax.Attributes;

import com.lowagie.text.ElementTags;

/**
 * This interface is implemented by the peer of all the iText objects.
 */

public class XmlPeer {

    /** This is the name of the alias. */
    protected String tagname;

    /** This is the name of the alias. */
    protected String customTagname;

    /** This is the Map that contains the aliases of the attributes. */
    protected Properties attributeAliases = new Properties();

    /** This is the Map that contains the default values of the attributes. */
    protected Properties attributeValues = new Properties();

    /** This is String that contains the default content of the attributes. */
    protected String defaultContent = null;

    /**
     * Creates a XmlPeer.
     *
     * @param name the iText name of a tag
     * @param alias the user defined name of a tag
     */

    public XmlPeer(String name, String alias) {
        this.tagname = name;
        this.customTagname = alias;
    }

    /**
     * Gets the tagname of the peer.
     *
     * @return the iText name of a tag
     */

    public String getTag() {
        return tagname;
    }

    /**
     * Gets the tagname of the peer.
     *
     * @return the user defined tagname
     */

    public String getAlias() {
        return customTagname;
    }

    /**
     * Gets the list of attributes of the peer.
     *
     * @param attrs the user defined set of attributes
     * @return the set of attributes translated to iText attributes
     */
    public Properties getAttributes(Attributes attrs) {
        Properties attributes = new Properties();
        attributes.putAll(attributeValues);
        if (defaultContent != null) {
            attributes.put(ElementTags.ITEXT, defaultContent);
        }
        if (attrs != null) {
            for (int i = 0; i < attrs.getLength(); i++) {
                String attribute = getName(attrs.getQName(i));
                attributes.setProperty(attribute, attrs.getValue(i));
            }
        }
        return attributes;
    }

    /**
     * Sets an alias for an attribute.
     *
     * @param name the iText tagname
     * @param alias the custom tagname
     */

    public void addAlias(String name, String alias) {
        attributeAliases.put(alias, name);
    }

    /**
     * Sets a value for an attribute.
     *
     * @param name the iText tagname
     * @param value the default value for this tag
     */

    public void addValue(String name, String value) {
        attributeValues.put(name, value);
    }

    /**
     * Sets the default content.
     *
     * @param content the default content
     */

    public void setContent(String content) {
        this.defaultContent = content;
    }

    /**
     * Returns the iText attribute name.
     *
     * @param name the custom attribute name
     * @return iText translated attribute name
     */

    public String getName(String name) {
        String value;
        if ((value = attributeAliases.getProperty(name)) != null) {
            return value;
        }
        return name;
    }

    /**
     * Returns the default values.
     *
     * @return A set of default (user defined) values
     */

    public Properties getDefaultValues() {
        return attributeValues;
    }
}