0.8.1-rc1/pcs/services/src/main/java/org/apache/oodt/pcs/services/PedigreeResource.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.oodt.pcs.services;

//JDK imports
import java.net.MalformedURLException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Vector;

//JAX-RS imports
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

//JSON imports
import net.sf.json.JSONObject;

//OODT imports
import org.apache.oodt.pcs.pedigree.Pedigree;
import org.apache.oodt.pcs.pedigree.PedigreeTree;
import org.apache.oodt.pcs.pedigree.PedigreeTreeNode;
import org.apache.oodt.pcs.util.FileManagerUtils;

/**
 * 
 * Exposes the {@link Pedigree} API of the PCS to provide an upstream and
 * downstream lineage of a particular OODT {@link Product} using JAX-RS.
 * 
 * @author mattmann
 * @version $Revision$
 * 
 */
@Path("pedigree")
public class PedigreeResource extends PCSService {

  private static final long serialVersionUID = 4851623546718112205L;

  private Pedigree trace;

  private FileManagerUtils fm;

  public PedigreeResource() throws MalformedURLException {
    this.fm = new FileManagerUtils(PCSService.conf.getFmUrl());
    this.trace = new Pedigree(this.fm, PCSService.conf
        .isTraceNotCatalogedFiles(), Arrays.asList(PCSService.conf
        .getTraceProductTypeExcludeList().split(",")));
  }

  @GET
  @Path("report/{filename}")
  @Produces("text/plain")
  public String generatePedigree(@PathParam("filename") String filename) {
    PedigreeTree upstreamTree = this.trace.doPedigree(this.fm
        .safeGetProductByName(filename), true);
    PedigreeTree downstreamTree = this.trace.doPedigree(this.fm
        .safeGetProductByName(filename), false);
    return this.encodePedigreeAsJson(upstreamTree, downstreamTree);
  }

  @GET
  @Path("report/{filename}/upstream")
  @Produces("text/plain")
  public String generateUpstreamPedigree(@PathParam("filename") String filename) {
    PedigreeTree upstreamTree = this.trace.doPedigree(this.fm
        .safeGetProductByName(filename), true);
    return this.encodePedigreeAsJson(upstreamTree, null);
  }

  @GET
  @Path("report/{filename}/downstream")
  @Produces("text/plain")
  public String generateDownstreamPedigree(
      @PathParam("filename") String filename) {
    PedigreeTree downstreamTree = this.trace.doPedigree(this.fm
        .safeGetProductByName(filename), false);
    return this.encodePedigreeAsJson(null, downstreamTree);
  }

  private String encodePedigreeAsJson(PedigreeTree up, PedigreeTree down) {
    Map<String, Object> output = new HashMap<String, Object>();
    if (up != null)
      output.put("upstream", this.encodePedigreeTreeAsJson(up.getRoot()));
    if (down != null)
      output.put("downstream", this.encodePedigreeTreeAsJson(down.getRoot()));
    JSONObject json = new JSONObject();
    json.put("pedigree", output);
    return json.toString();
  }

  private Object encodePedigreeTreeAsJson(PedigreeTreeNode node) {
    if (node.getNumChildren() > 0) {
      Map<String, Object> map = new HashMap<String, Object>();
      List<Object> list = new Vector<Object>();
      for (int i = 0; i < node.getNumChildren(); i++) {
        list.add(this
            .encodePedigreeTreeAsJson(node.getChildAt(i)));
      }
      map.put(node.getNodeProduct().getProductName(), list);
      return map;
    } else {
      return node.getNodeProduct().getProductName();
    }
  }
}