/*
* org.openmicroscopy.shoola.env.config.IconFactoryEntry
*
*------------------------------------------------------------------------------
* Copyright (C) 2006 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.env.config;
//Java imports
import java.util.HashMap;
import java.util.Map;
//Third-party libraries
import org.w3c.dom.DOMException;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
//Application-internal dependencies
/**
* Handles a <i>structuredEntry</i> of type <i>icons</i>.
* The content of the entry is used to build an {@link IconFactory} object,
* which is then returned by the {@link #getValue() getValue} method.
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author <br>Andrea Falconi
* <a href="mailto:a.falconi@dundee.ac.uk">
* a.falconi@dundee.ac.uk</a>
* @version 2.2
* <small>
* (<b>Internal version:</b> $Revision$ $Date$)
* </small>
* @since OME2.2
*/
class IconFactoryEntry
extends Entry
{
/**
* The name of the tag, within this <i>structuredEntry</i>, that specifies
* the location to use for building the {@link IconFactory} object.
*/
private static final String LOCATION_TAG = "location";
/** Holds the contents of the entry. */
private String location;
/** The returned value built from {@link #location}. */
private IconFactory factory;
/**
* Extracts the values of the tags within the entry tag and puts them in
* a map keyed by tag names.
*
* @param entry The <i>icons</i> entry tag.
* @return A map whose keys are names of the tags within the entry and
* values are the corresponding tag contents.
* @throws DOMException If the entry contents couldn't be retrieved.
* @throws ConfigException If the entry is not structured as expected.
*/
private Map<String, String> extractValues(Node entry)
throws DOMException, ConfigException
{
if (entry.hasChildNodes()) {
Map<String, String> tags = new HashMap<String, String>();
NodeList children = entry.getChildNodes();
int n = children.getLength();
Node child;
while (0 < n) {
child = children.item(--n);
if (child.getNodeType() == Node.ELEMENT_NODE &&
LOCATION_TAG.equals(child.getNodeName())) {
tags.put(LOCATION_TAG,
child.getFirstChild().getNodeValue());
return tags;
}
}
}
throw new ConfigException(
"The content of the icons structured entry is not valid.");
}
//TODO: remove the checks (which are not complete anyway) and the
//ConfigException when we have an XML schema for config files.
//NOTE: the method above could just return a string. However, for the
//time being we keep it like that b/c in future we might add some other
//tags other than location to the icons entry.
/** Creates a new instance. */
IconFactoryEntry() {}
/**
* Returns a {@link IconFactory} object to handle all icons in the
* location specified by the configuration entry.
*
* @return See above.
*/
Object getValue()
{
if (factory == null) factory = new IconFactory(location);
return factory;
}
/**
* Implemented as specified by {@link Entry}.
* @see Entry#setContent(Node)
* @throws ConfigException If the configuration entry couldn't be handled.
*/
protected void setContent(Node node)
throws ConfigException
{
try {
Map<String, String> tags = extractValues(node);
location = (String) tags.get(LOCATION_TAG);
} catch (DOMException dex) {
rethrow("Can't parse icons entry.", dex);
}
}
}