ingo@99: package de.intevation.flys.client.server;
ingo@99: 
ingo@99: import java.util.ArrayList;
ingo@524: import java.util.HashMap;
ingo@99: import java.util.List;
ingo@524: import java.util.Map;
ingo@99: 
ingo@99: import javax.xml.xpath.XPathConstants;
ingo@99: 
ingo@99: import org.w3c.dom.Document;
ingo@99: import org.w3c.dom.Node;
ingo@99: import org.w3c.dom.NodeList;
ingo@99: 
ingo@99: import com.google.gwt.user.server.rpc.RemoteServiceServlet;
ingo@99: 
ingo@99: import de.intevation.artifacts.common.ArtifactNamespaceContext;
ingo@99: import de.intevation.artifacts.common.utils.ClientProtocolUtils;
ingo@99: import de.intevation.artifacts.common.utils.XMLUtils;
ingo@99: 
ingo@99: import de.intevation.artifacts.httpclient.exceptions.ConnectionException;
ingo@99: import de.intevation.artifacts.httpclient.http.HttpClient;
ingo@99: import de.intevation.artifacts.httpclient.http.HttpClientImpl;
ingo@99: import de.intevation.artifacts.httpclient.http.response.DocumentResponseHandler;
ingo@99: 
ingo@215: import de.intevation.flys.client.shared.exceptions.ServerException;
ingo@99: import de.intevation.flys.client.shared.model.Collection;
ingo@99: import de.intevation.flys.client.shared.model.CollectionItem;
ingo@99: import de.intevation.flys.client.shared.model.DefaultCollection;
ingo@99: import de.intevation.flys.client.shared.model.DefaultCollectionItem;
ingo@270: import de.intevation.flys.client.shared.model.DefaultFacet;
ingo@99: import de.intevation.flys.client.shared.model.DefaultOutputMode;
ingo@524: import de.intevation.flys.client.shared.model.DefaultTheme;
ingo@270: import de.intevation.flys.client.shared.model.ExportMode;
ingo@270: import de.intevation.flys.client.shared.model.Facet;
ingo@99: import de.intevation.flys.client.shared.model.OutputMode;
ingo@524: import de.intevation.flys.client.shared.model.Theme;
ingo@524: import de.intevation.flys.client.shared.model.ThemeList;
ingo@99: import de.intevation.flys.client.client.services.DescribeCollectionService;
ingo@99: 
ingo@99: 
ingo@99: /**
ingo@99:  * This service implements a method that queries the DESCRIBE document of a
ingo@99:  * specific collection and returns a Collection object with the information of
ingo@99:  * the document.
ingo@99:  *
ingo@99:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@99:  */
ingo@99: public class DescribeCollectionServiceImpl
ingo@99: extends      RemoteServiceServlet
ingo@99: implements   DescribeCollectionService
ingo@99: {
ingo@215:     /** The error message key that is thrown if an error occured while
ingo@215:      * describe() a Collection.*/
ingo@215:     public static final String ERROR_DESCRIBE_COLLECTION =
ingo@215:         "error_describe_collection";
ingo@215: 
ingo@270:     public static final String XPATH_FACETS = "art:facets/art:facet";
ingo@270: 
ingo@215: 
ingo@229:     public Collection describe(String uuid, String serverUrl, String locale)
ingo@215:     throws ServerException
ingo@215:     {
ingo@99:         System.out.println("DescribeCollectionServiceImpl.describe");
ingo@99: 
ingo@99:         Document describe = ClientProtocolUtils.newDescribeCollectionDocument(
ingo@99:             uuid);
ingo@99: 
ingo@229:         HttpClient client = new HttpClientImpl(serverUrl, locale);
ingo@99: 
ingo@99:         try {
ingo@99:             Document response = (Document) client.doCollectionAction(
ingo@99:                 describe, uuid, new DocumentResponseHandler());
ingo@99: 
ingo@99:             Collection c = parseCollection(response);
ingo@99: 
ingo@99:             if (c == null) {
ingo@215:                 throw new ServerException(ERROR_DESCRIBE_COLLECTION);
ingo@99:             }
ingo@99: 
ingo@524:             System.out.println("Collection successfully parsed.");
ingo@524: 
ingo@99:             return c;
ingo@99:         }
ingo@99:         catch (ConnectionException ce) {
ingo@99:             System.err.println(ce.getLocalizedMessage());
ingo@99:         }
ingo@99: 
ingo@215:         throw new ServerException(ERROR_DESCRIBE_COLLECTION);
ingo@99:     }
ingo@99: 
ingo@99: 
ingo@99:     /**
ingo@99:      * This method takes the DESCRIBE document of the Collections describe()
ingo@99:      * operation and extracts the information about the collection itself and
ingo@99:      * the collection items.
ingo@99:      *
ingo@99:      * @param description The DESCRIBE document of the Collections describe()
ingo@99:      * operation.
ingo@99:      *
ingo@99:      * @return a Collection with CollectionItems.
ingo@99:      */
ingo@99:     protected Collection parseCollection(Document description) {
ingo@99:         System.out.println("AddArtifactServiceImpl.parseCollection");
ingo@99: 
ingo@99:         if (description == null) {
ingo@99:             System.err.println("The DESCRIBE of the Collection is null!");
ingo@99:             return null;
ingo@99:         }
ingo@99: 
ingo@99:         String uuid = XMLUtils.xpathString(
ingo@99:             description,
ingo@99:             "art:artifact-collection/@art:uuid",
ingo@99:             ArtifactNamespaceContext.INSTANCE);
ingo@99: 
ingo@99:         if (uuid == null || uuid.equals("")) {
ingo@99:             System.err.println("Found an invalid Collection!");
ingo@99:             return null;
ingo@99:         }
ingo@99: 
ingo@524:         Map<String, ThemeList> themeList = parseThemeLists(description);
ingo@524: 
ingo@524:         Collection c = null;
ingo@524: 
ingo@524:         if (themeList != null) {
ingo@524:             c = new DefaultCollection(uuid, themeList);
ingo@524:             //c = new DefaultCollection(uuid);
ingo@524:         }
ingo@524:         else {
ingo@524:             c = new DefaultCollection(uuid);
ingo@524:         }
ingo@99: 
ingo@99:         NodeList items = (NodeList) XMLUtils.xpath(
ingo@99:             description,
ingo@99:             "art:artifact-collection/art:artifacts/art:artifact",
ingo@99:             XPathConstants.NODESET,
ingo@99:             ArtifactNamespaceContext.INSTANCE);
ingo@99: 
ingo@99:         if (items == null || items.getLength() == 0) {
ingo@99:             System.out.println("No collection item found for this collection.");
ingo@99: 
ingo@99:             return c;
ingo@99:         }
ingo@99: 
ingo@99:         int size = items.getLength();
ingo@99: 
ingo@99:         for (int i = 0; i < size; i++) {
ingo@99:             CollectionItem item = parseCollectionItem(items.item(i));
ingo@99: 
ingo@99:             if (item != null) {
ingo@99:                 c.addItem(item);
ingo@99:             }
ingo@99:         }
ingo@99: 
ingo@99:         System.out.println(
ingo@99:             "Found " + c.getItemLength() + " collection items " +
ingo@99:             "for the Collection '" + c.identifier() + "'.");
ingo@99: 
ingo@99:         return c;
ingo@99:     }
ingo@99: 
ingo@99: 
ingo@524:     protected Map<String, ThemeList> parseThemeLists(Document description) {
ingo@524:         System.out.println("DescribeCollectionServiceImpl.parseThemeLists");
ingo@524: 
ingo@524:         NodeList lists = (NodeList) XMLUtils.xpath(
ingo@524:             description,
ingo@524:             "/art:artifact-collection/art:attribute/art:outputs/art:output",
ingo@524:             XPathConstants.NODESET,
ingo@524:             ArtifactNamespaceContext.INSTANCE);
ingo@524: 
ingo@524:         int num = lists != null ? lists.getLength() : 0;
ingo@524: 
ingo@524:         Map<String, ThemeList> themeList = new HashMap<String, ThemeList>(num);
ingo@524: 
ingo@524:         for (int i = 0; i < num; i++) {
ingo@524:             Node node = lists.item(i);
ingo@524: 
ingo@524:             String outName = XMLUtils.xpathString(
ingo@524:                 node, "@name", ArtifactNamespaceContext.INSTANCE);
ingo@524: 
ingo@524:             ThemeList list = parseThemeList(node);
ingo@524: 
ingo@524:             if (list != null) {
ingo@524:                 themeList.put(outName, list);
ingo@524:             }
ingo@524:         }
ingo@524: 
ingo@524:         return themeList;
ingo@524:     }
ingo@524: 
ingo@524: 
ingo@524:     protected ThemeList parseThemeList(Node node) {
ingo@524:         System.out.println("DescribeCollectionServiceImpl.parseThemeList");
ingo@524: 
ingo@524:         NodeList themes = (NodeList) XMLUtils.xpath(
ingo@524:             node,
ingo@524:             "art:theme",
ingo@524:             XPathConstants.NODESET,
ingo@524:             ArtifactNamespaceContext.INSTANCE);
ingo@524: 
ingo@524:         int num = themes != null ? themes.getLength() : 0;
ingo@524: 
ingo@524:         List<Theme> themeList = new ArrayList<Theme>(num);
ingo@524: 
ingo@524:         for (int i = 0; i < num; i++) {
ingo@524:             Theme theme = parseTheme(themes.item(i));
ingo@524: 
ingo@524:             if (theme != null) {
ingo@524:                 themeList.add(theme);
ingo@524:             }
ingo@524:         }
ingo@524: 
ingo@524:         return new ThemeList(themeList);
ingo@524:     }
ingo@524: 
ingo@524: 
ingo@524:     protected Theme parseTheme(Node node) {
ingo@524:         System.out.println("DescribeCollectionServiceImpl.parseTheme");
ingo@524: 
ingo@524:         String strAct = XMLUtils.xpathString(
ingo@524:             node, "@art:active", ArtifactNamespaceContext.INSTANCE);
ingo@524: 
ingo@524:         String art = XMLUtils.xpathString(
ingo@524:             node, "@art:artifact", ArtifactNamespaceContext.INSTANCE);
ingo@524: 
ingo@524:         String fac = XMLUtils.xpathString(
ingo@524:             node, "@art:facet", ArtifactNamespaceContext.INSTANCE);
ingo@524: 
ingo@524:         String strPos = XMLUtils.xpathString(
ingo@524:             node, "@art:pos", ArtifactNamespaceContext.INSTANCE);
ingo@524: 
ingo@524:         if (strAct != null && art != null && fac != null && strPos != null) {
ingo@524:             try {
ingo@524:                 int pos    = Integer.valueOf(strPos);
ingo@524:                 int active = Integer.valueOf(strAct);
ingo@524: 
ingo@524:                 return new DefaultTheme(pos, active > 0, art, fac);
ingo@524:             }
ingo@524:             catch (NumberFormatException nfe) {
ingo@524:                 nfe.printStackTrace();
ingo@524:             }
ingo@524:         }
ingo@524: 
ingo@524:         return null;
ingo@524:     }
ingo@524: 
ingo@524: 
ingo@99:     /**
ingo@99:      * This method extracts the CollectionItem from <i>node</i> with its output
ingo@99:      * modes. The output modes are parsed using the parseOutputModes() method.
ingo@99:      *
ingo@99:      * @param node A node that contains information about a CollectionItem.
ingo@99:      *
ingo@99:      * @return a CollectionItem.
ingo@99:      */
ingo@99:     protected CollectionItem parseCollectionItem(Node node) {
ingo@99:         System.out.println("AddArtifactServiceImpl.parseCollectionItem");
ingo@99: 
ingo@99:         if (node == null) {
ingo@99:             System.err.println("The node for parsing CollectionItem is null!");
ingo@99:             return null;
ingo@99:         }
ingo@99: 
ingo@99:         String uuid = XMLUtils.xpathString(
ingo@99:             node, "@art:uuid", ArtifactNamespaceContext.INSTANCE);
ingo@99: 
ingo@99:         String hash = XMLUtils.xpathString(
ingo@99:             node, "@art:hash", ArtifactNamespaceContext.INSTANCE);
ingo@99: 
ingo@99:         if (uuid == null || uuid.equals("")) {
ingo@99:             System.err.println("Found an invalid CollectionItem!");
ingo@99:         }
ingo@99: 
ingo@99:         Node outputmodes = (Node) XMLUtils.xpath(
ingo@99:             node,
ingo@99:             "art:outputmodes",
ingo@99:             XPathConstants.NODE,
ingo@99:             ArtifactNamespaceContext.INSTANCE);
ingo@99: 
ingo@99:         List<OutputMode> modes = parseOutputModes(outputmodes);
ingo@99: 
ingo@99:         return new DefaultCollectionItem(uuid, hash, modes);
ingo@99:     }
ingo@99: 
ingo@99: 
ingo@99:     /**
ingo@99:      * This method extracts the OutputModes available for a specific
ingo@99:      * CollectionItem and returns them as list.
ingo@99:      *
ingo@99:      * @param node The root node of the outputmodes list.
ingo@99:      *
ingo@99:      * @return a list of OutputModes.
ingo@99:      */
ingo@99:     protected List<OutputMode> parseOutputModes(Node node) {
ingo@99:         System.out.println("AddArtifactServiceImpl.parseOutputModes");
ingo@99: 
ingo@99:         if (node == null) {
ingo@99:             System.err.println("The node for parsing OutputModes is null!");
ingo@99:             return null;
ingo@99:         }
ingo@99: 
ingo@99:         NodeList list = (NodeList) XMLUtils.xpath(
ingo@99:             node,
ingo@99:             "art:output",
ingo@99:             XPathConstants.NODESET,
ingo@99:             ArtifactNamespaceContext.INSTANCE);
ingo@99: 
ingo@99:         if (list == null || list.getLength() == 0) {
ingo@99:             System.err.println("No outputmode nodes found!");
ingo@99:             return null;
ingo@99:         }
ingo@99: 
ingo@99:         int size = list.getLength();
ingo@99: 
ingo@99:         List<OutputMode> modes = new ArrayList<OutputMode>(size);
ingo@99: 
ingo@99:         for (int i = 0; i < size; i++) {
ingo@99:             Node   tmp  = list.item(i);
ingo@99:             String name = XMLUtils.xpathString(
ingo@99:                 tmp, "@art:name", ArtifactNamespaceContext.INSTANCE);
ingo@99:             String desc = XMLUtils.xpathString(
ingo@99:                 tmp, "@art:description", ArtifactNamespaceContext.INSTANCE);
ingo@99:             String mime = XMLUtils.xpathString(
ingo@99:                 tmp, "@art:mime-type", ArtifactNamespaceContext.INSTANCE);
ingo@99: 
ingo@99:             if (name == null || name.equals("")) {
ingo@99:                 System.err.println("Found an invalid output mode.");
ingo@99: 
ingo@99:                 continue;
ingo@99:             }
ingo@99: 
ingo@270:             OutputMode outmode = null;
ingo@270:             List<Facet> fs     = extractFacets(tmp);
ingo@99: 
ingo@270:             if (name.indexOf("export") > -1) {
ingo@270:                 outmode = new ExportMode(name, desc, mime, fs);
ingo@270:             }
ingo@270:             else {
ingo@270:                 outmode = new DefaultOutputMode(name, desc, mime, fs);
ingo@270:             }
ingo@270: 
ingo@270:             modes.add(outmode);
ingo@99:         }
ingo@99: 
ingo@99:         return modes;
ingo@99:     }
ingo@270: 
ingo@270: 
ingo@270:     protected static List<Facet> extractFacets(Node outmode) {
ingo@270:         System.out.println("ArtifactDescriptionFactory - extractFacets()");
ingo@270: 
ingo@270:         NodeList facetList = (NodeList) XMLUtils.xpath(
ingo@270:             outmode,
ingo@270:             XPATH_FACETS,
ingo@270:             XPathConstants.NODESET,
ingo@270:             ArtifactNamespaceContext.INSTANCE);
ingo@270: 
ingo@270:         int num = facetList != null ? facetList.getLength() : 0;
ingo@270: 
ingo@270:         List<Facet> facets = new ArrayList<Facet>(num);
ingo@270: 
ingo@270:         for (int i = 0; i < num; i++) {
ingo@270:             Node facetNode = facetList.item(i);
ingo@270: 
ingo@270:             String name = XMLUtils.xpathString(
ingo@270:                 facetNode, "@art:name", ArtifactNamespaceContext.INSTANCE);
ingo@270: 
ingo@270:             if (name != null && name.length() > 0) {
ingo@270:                 facets.add(new DefaultFacet(name));
ingo@270:             }
ingo@270:         }
ingo@270: 
ingo@270:         return facets;
ingo@270:     }
ingo@99: }
ingo@99: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :