org.simpleframework.xml.stream.PrefixResolver Maven / Gradle / Ivy
/*
* PrefixResolver.java July 2008
*
* Copyright (C) 2008, Niall Gallagher
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
package org.simpleframework.xml.stream;
import java.util.Iterator;
import java.util.LinkedHashMap;
/**
* The PrefixResolver object will store the namespaces
* for an element. Each namespace added to this map can be added
* with a prefix. A prefix is added only if the associated reference
* has not been added to a parent element. If a parent element has
* the associated reference, then the parents prefix is the one that
* will be returned when requested from this map.
*
* @author Niall Gallagher
*
* @see org.simpleframework.xml.stream.OutputElement
*/
class PrefixResolver extends LinkedHashMap implements NamespaceMap {
/**
* Represents the actual XML element this is associated with.
*/
private final OutputNode source;
/**
* Constructor for the PrefixResolver object. This
* is used to create a resolver for namespace prefixes using
* the hierarchy of elements. Resolving the prefix in this way
* avoids having to redeclare the same namespace with another
* prefix in a child element if it has already been declared.
*
* @param source this is the XML element this is associated to
*/
public PrefixResolver(OutputNode source) {
this.source = source;
}
/**
* This is the prefix that is associated with the source element.
* If the source element does not contain a namespace reference
* then this will return its parents namespace. This ensures
* that if a namespace has been declared its child elements will
* inherit its prefix.
*
* @return this returns the prefix that is currently in scope
*/
public String getPrefix() {
return source.getPrefix();
}
/**
* This is used to add the namespace reference to the namespace
* map. If the namespace has been added to a parent node then
* this will not add the reference. The prefix added to the map
* will be the default namespace, which is an empty prefix.
*
* @param reference this is the reference to be added
*
* @return this returns the prefix that has been replaced
*/
public String put(String reference) {
return put(reference, "");
}
/**
* This is used to add the namespace reference to the namespace
* map. If the namespace has been added to a parent node then
* this will not add the reference.
*
* @param reference this is the reference to be added
* @param prefix this is the prefix to be added to the reference
*
* @return this returns the prefix that has been replaced
*/
public String put(String reference, String prefix) {
String parent = resolve(reference);
if(parent != null) {
return null;
}
return super.put(reference, prefix);
}
/**
* This is used to remove the prefix that is matched to the
* given reference. If no prefix is matched to the reference then
* this will silently return. This will only remove mappings
* from the current map, and will ignore the parent nodes.
*
* @param reference this is the reference that is to be removed
*
* @return this returns the prefix that was matched to this
*/
public String remove(String reference) {
return super.remove(reference);
}
/**
* This acquires the prefix for the specified namespace reference.
* If the namespace reference has been set on this node with a
* given prefix then that prefix is returned, however if it has
* not been set this will search the parent elements to find the
* prefix that is in scope for the specified reference.
*
* @param reference the reference to find a matching prefix for
*
* @return this will return the prefix that is is scope
*/
public String get(String reference) {
int size = size();
if(size > 0) {
String prefix = super.get(reference);
if(prefix != null) {
return prefix;
}
}
return resolve(reference);
}
/**
* This method will resolve the prefix or the specified reference
* by searching the parent nodes in order. This allows the prefix
* that is currently in scope for the reference to be acquired.
*
* @param reference the reference to find a matching prefix for
*
* @return this will return the prefix that is is scope
*/
private String resolve(String reference) {
NamespaceMap parent = source.getNamespaces();
if(parent == null) {
return null;
}
return parent.get(reference);
}
/**
* This returns an iterator for the namespace of all the nodes
* in this NamespaceMap. This allows the namespaces
* to be iterated within a for each loop in order to extract the
* prefix values associated with the map.
*
* @return this returns the namespaces contained in this map
*/
public Iterator iterator() {
return keySet().iterator();
}
}