com.tailf.jnc.PrefixMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play-jnc Show documentation
play-jnc
The newest version!
package com.tailf.jnc;

import java.util.ArrayList;

/**
 * This class implements a list of prefix mappings, which provides mappings
 * from namespaces to prefixes.
 * 
 **/
public class PrefixMap extends ArrayList {

    private static final long serialVersionUID = 1L;

    /**
     * Creates an empty prefix map object.
     */
    public PrefixMap() {
    }

    /**
     * Inserts a prefix initially in the new prefix map.
     */
    public PrefixMap(Prefix p) {
        add(p);
    }

    /**
     * Inserts an array of prefixes initially in the new prefix map.
     */
    public PrefixMap(Prefix[] prefixes) {
        for (Prefix p : prefixes) {
            add(p);
        }
    }

    /**
     * Nondestructively merges a prefix map with this object.
     * 
     * @param prefixes The prefix map to merge with.
     */
    public void merge(PrefixMap prefixes) {
        for (Prefix p : prefixes) {
            merge(p);
        }
    }

    /**
     * Non-destructively merges a prefix in the prefix map.
     * 
     * @param prefix the prefix to add if not already present.
     */
    public void merge(Prefix prefix) {
        final int index = indexOfName(prefix.name);
        if (index == -1) {
            add(prefix);
        }
    }

    /**
     * Stores the prefixes in the prefix map. Replaces those that already
     * exists, and add the new ones that doesn't exist.
     * 
     * @param prefixes Prefix mappings
     */
    public void set(PrefixMap prefixes) {
        trace("set: " + prefixes);
        for (Prefix p : prefixes) {
            set(p);
        }
    }

    /**
     * Stores a prefix in the prefix map. Replace any old occurrence.
     * 
     * @param prefix Prefix mapping to be set
     */
    public void set(Prefix prefix) {
        final int index = indexOfName(prefix.name);
        if (index == -1) {
            if (prefix.name.equals("")) {
                add(0, prefix); // add default prefix first in the prefix map
            } else {
                add(prefix);
            }
        } else {
            set(index, prefix);
        }
    }

    /**
     * Removes a prefix mapping.
     * 
     * @param prefix Name of prefix mapping to be removed.
     */
    public void remove(String prefix) {
        final int index = indexOfName(prefix);
        if (index >= 0) {
            remove(index);
        }
    }

    /**
     * Gets the prefix at specified index.
     * 
     * @param i Index of prefix mapping to get.
     * @return Prefix mapping
     */
    public Prefix getPrefix(int i) {
        return super.get(i);
    }

    /**
     * Returns the index of the prefix name in the prefix map.
     * 
     * @param name The prefix name
     * @return Index of prefix mapping with specified prefix name
     */
    public int indexOfName(String name) {
        // trace("indexOfName("+name+")");
        for (int i = 0; i < size(); i++) {
            if (name.equals(getPrefix(i).name)) {
                return i;
            }
        }
        return -1;
    }

    /**
     * Lookups prefix name in the prefix map. Return the Prefix object.
     * 
     * @param name The prefix name
     * @return Prefix mapping
     */
    public Prefix lookup(String name) {
        // trace("lookup("+name+")");
        for (int i = 0; i < size(); i++) {
            final Prefix p = getPrefix(i);
            if (name.equals(p.name)) {
                return p;
            }
        }
        return null;
    }

    /**
     * Lookups namespace and returns prefix for it.
     * 
     * @param ns The namespace to lookup in this prefix
     */
    public String nsToPrefix(String ns) {
        // trace("nsToPrefix(\""+ns+"\")");
        for (int i = 0; i < size(); i++) {
            final Prefix p = getPrefix(i);
            if (p.ns != null && ns.equals(p.value)) {
                return p.name;
            }
        }
        return null;
    }

    /**
     * Lookups prefix and returns the associated namespace
     */
    public String prefixToNs(String name) {
        // trace("prefixToNs("+name+")");
        for (int i = 0; i < size(); i++) {
            final Prefix p = getPrefix(i);
            if (name.equals(p.name)) {
                return p.value;
            }
        }
        return null;
    }

    /* help functions */

    /**
     * Printout trace if 'debug'-flag is enabled.
     */
    private void trace(String s) {
        if (Element.debugLevel >= Element.DEBUG_LEVEL_PREFIXMAP) {
            System.err.println("*PrefixMap: " + s);
        }
    }

}