Metacat

Crosswalks.eml-2.0.0=edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml200

Crosswalks.eml-2.0.1=edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml201

Crosswalks.eml-2.1.0=edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml210

/**

 * Copyright 2006 OCLC Online Computer Library Center Licensed 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 edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk;

import java.util.HashMap;

import java.util.Properties;

import org.apache.log4j.Logger;

import ORG.oclc.oai.server.crosswalk.Crosswalk;

import ORG.oclc.oai.server.verb.CannotDisseminateFormatException;

import ORG.oclc.oai.server.verb.OAIInternalServerError;

/**

 * Provides eml-2.0.0 documents. We simply return the metadata that was read 

 * from Metacat.

 */

public class Eml200 extends Crosswalk {

  /* Class fields */

  private static final Logger logger = Logger.getLogger(Eml200.class);

  private static final String SCHEMA_LOCATION =

    "eml://ecoinformatics.org/eml-2.0.0 " +

    "http://knb.ecoinformatics.org/knb/schema/eml-2.0.0/eml.xsd";

  /* Constructors */

  /**

   * The constructor assigns the schemaLocation associated with this crosswalk.

   * Since the crosswalk is trivial in this case, no properties are utilized.

   * 

   * @param properties

   *          properties that are needed to configure the crosswalk.

   */

  public Eml200(Properties properties) throws OAIInternalServerError {

    super(SCHEMA_LOCATION);

  }

  /* Class methods */

  /* Instance methods */

  /**

   * Perform the actual crosswalk.

   * 

   * @param nativeItem  A HashMap object that contains the EML string that was

   *                    retrieved from Metacat and stored as the value of the

   *                    "recordBytes" key

   *                    

   * @return emlDoc  a String containing the metadata to be stored within 

   *                    the <metadata> element

   *                    

   * @exception CannotDisseminateFormatException

   *                    nativeItem doesn't support this format.

   */

  public String createMetadata(Object nativeItem)

      throws CannotDisseminateFormatException {

    HashMap recordMap = (HashMap) nativeItem;

    String xmlRec = (String) recordMap.get("recordBytes");    

    String emlDoc = xmlRec.trim();

    /*

     * Remove the lead xml processing instruction because the document is going

     * to be placed inside an OAI <metadata> element.

     */

    if (emlDoc.startsWith("<?")) {

      int offset = emlDoc.indexOf("?>");

      emlDoc = emlDoc.substring(offset + 2);

    }

    return emlDoc;

  }

  /**

   * Can this nativeItem be represented in 'eml-2.0.0' format?

   * 

   * @param nativeItem              a record in native format

   * @return true if 'eml-2.0.0' format is possible, false otherwise.

   */

  public boolean isAvailableFor(Object nativeItem) {

    boolean isAvailable = false;

    HashMap recordMap = (HashMap) nativeItem;

    String doctype = (String) recordMap.get("doctype");

    if (doctype.equals("eml://ecoinformatics.org/eml-2.0.0")) {

      isAvailable = true;

    }

    return isAvailable;

  }

}

/**

 * Copyright 2006 OCLC Online Computer Library Center Licensed 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 edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk;

import java.util.HashMap;

import java.util.Properties;

import org.apache.log4j.Logger;

import ORG.oclc.oai.server.crosswalk.Crosswalk;

import ORG.oclc.oai.server.verb.CannotDisseminateFormatException;

import ORG.oclc.oai.server.verb.OAIInternalServerError;

/**

 * Provides eml-2.0.1 documents. We simply return the metadata that was read 

 * from Metacat.

 */

public class Eml201 extends Crosswalk {

  /* Class fields */

  private static final Logger logger = Logger.getLogger(Eml201.class);

  private static final String SCHEMA_LOCATION =

    "eml://ecoinformatics.org/eml-2.0.1 " +

    "http://knb.ecoinformatics.org/knb/schema/eml-2.0.1/eml.xsd";

  /* Constructors */

  /**

   * The constructor assigns the schemaLocation associated with this crosswalk.

   * Since the crosswalk is trivial in this case, no properties are utilized.

   * 

   * @param properties

   *          properties that are needed to configure the crosswalk.

   */

  public Eml201(Properties properties) throws OAIInternalServerError {

    super(SCHEMA_LOCATION);

  }

  /* Class methods */

  /* Instance methods */

  /**

   * Perform the actual crosswalk.

   * 

   * @param nativeItem  A HashMap object that contains the EML string that was

   *                    retrieved from Metacat and stored as the value of the

   *                    "recordBytes" key

   *                    

   * @return emlDoc  a String containing the metadata to be stored within 

   *                    the <metadata> element

   *                    

   * @exception CannotDisseminateFormatException

   *                    nativeItem doesn't support this format.

   */

  public String createMetadata(Object nativeItem)

      throws CannotDisseminateFormatException {

    HashMap recordMap = (HashMap) nativeItem;

    String xmlRec = (String) recordMap.get("recordBytes");    

    String emlDoc = xmlRec.trim();

    /*

     * Remove the lead xml processing instruction because the document is going

     * to be placed inside an OAI <metadata> element.

     */

    if (emlDoc.startsWith("<?")) {

      int offset = emlDoc.indexOf("?>");

      emlDoc = emlDoc.substring(offset + 2);

    }

    return emlDoc;

  }

  /**

   * Can this nativeItem be represented in 'eml-2.0.1' format?

   * 

   * @param nativeItem              a record in native format

   * @return true if 'eml-2.0.1' format is possible, false otherwise.

   */

  public boolean isAvailableFor(Object nativeItem) {

    boolean isAvailable = false;

    HashMap recordMap = (HashMap) nativeItem;

    String doctype = (String) recordMap.get("doctype");

    if (doctype.equals("eml://ecoinformatics.org/eml-2.0.1")) {

      isAvailable = true;

    }

    return isAvailable;

  }

}

/**

 * Copyright 2006 OCLC Online Computer Library Center Licensed 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 edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk;

import java.util.HashMap;

import java.util.Properties;

import org.apache.log4j.Logger;

import ORG.oclc.oai.server.crosswalk.Crosswalk;

import ORG.oclc.oai.server.verb.CannotDisseminateFormatException;

import ORG.oclc.oai.server.verb.OAIInternalServerError;

/**

 * Provides eml-2.1.0 documents. We simply return the metadata that was read 

 * from Metacat.

 */

public class Eml210 extends Crosswalk {

  /* Class fields */

  private static final Logger logger = Logger.getLogger(Eml210.class);

  private static final String SCHEMA_LOCATION =

    "eml://ecoinformatics.org/eml-2.1.0 " +

    "http://knb.ecoinformatics.org/knb/schema/eml-2.1.0/eml.xsd";

  /* Constructors */

  /**

   * The constructor assigns the schemaLocation associated with this crosswalk.

   * Since the crosswalk is trivial in this case, no properties are utilized.

   * 

   * @param properties

   *          properties that are needed to configure the crosswalk.

   */

  public Eml210(Properties properties) throws OAIInternalServerError {

    super(SCHEMA_LOCATION);

  }

  /* Class methods */

  /* Instance methods */

  /**

   * Perform the actual crosswalk.

   * 

   * @param nativeItem  A HashMap object that contains the EML string that was

   *                    retrieved from Metacat and stored as the value of the

   *                    "recordBytes" key

   *                    

   * @return emlDoc  a String containing the metadata to be stored within 

   *                    the <metadata> element

   *                    

   * @exception CannotDisseminateFormatException

   *                    nativeItem doesn't support this format.

   */

  public String createMetadata(Object nativeItem)

      throws CannotDisseminateFormatException {

    HashMap recordMap = (HashMap) nativeItem;

    String xmlRec = (String) recordMap.get("recordBytes");    

    String emlDoc = xmlRec.trim();

    /*

     * Remove the lead xml processing instruction because the document is going

     * to be placed inside an OAI <metadata> element.

     */

    if (emlDoc.startsWith("<?")) {

      int offset = emlDoc.indexOf("?>");

      emlDoc = emlDoc.substring(offset + 2);

    }

    return emlDoc;

  }

  /**

   * Can this nativeItem be represented in 'eml-2.1.0' format?

   * 

   * @param nativeItem              a record in native format

   * @return true if 'eml-2.1.0' format is possible, false otherwise.

   */

  public boolean isAvailableFor(Object nativeItem) {

    boolean isAvailable = false;

    HashMap recordMap = (HashMap) nativeItem;

    String doctype = (String) recordMap.get("doctype");

    if (doctype.equals("eml://ecoinformatics.org/eml-2.1.0")) {

      isAvailable = true;

    }

    return isAvailable;

  }

}

  private HashMap<String, String> filteredDateMap = null;

  /**

   * Using the original dateMap catalog, produce a filtered dateMap catalog

   * consisting of only those entries that match the 'from', 'until', and

   * 'metadataPrefix' criteria.

   * 

   * @param from                 the from date, e.g. "2008-06-01"

   * @param until                the until date, e.g. "2009-01-01"

   * @param metadataPrefix       the metadataPrefix value, e.g. "oai_dc"

   * 

   * @return   aDateMap, a HashMap containing only the matched entries.

   */

  private HashMap<String, String> filterDateMap(String from, String until,

      String metadataPrefix) {

    HashMap<String, String> aDateMap = new HashMap<String, String>();

    Iterator iterator = dateMap.entrySet().iterator();

    while (iterator.hasNext()) {

      Map.Entry entryDateMap = (Map.Entry) iterator.next();

      String dateUpdated = (String) entryDateMap.getValue();

      /*

       * First filter catalog entries based on whether their date updated falls

       * within the 'from' and 'until' parameters.

       */

      if (dateUpdated.compareTo(from) >= 0 && dateUpdated.compareTo(until) <= 0) 

      {

        String docid = (String) entryDateMap.getKey();

        HashMap<String, String> nativeHeader = getNativeHeader(docid);

        String doctype = nativeHeader.get("doctype");

        /*

         * Next filter catalog entries based on Metacat doctype as compared to

         * OAI-PMH metadataPrefix.

         */

        if (isIncludedDoctype(doctype, metadataPrefix)) {

          aDateMap.put(docid, dateUpdated);

        }

      }

    }

    return aDateMap;

   * Should a document with the specified Metacat doctype be included in the

   * list of identifiers/records for the specified OAI-PMH metadataPrefix?

   * 

   * @param doctype              e.g. "eml://ecoinformatics.org/eml-2.1.0"

   * @param metadataPrefix       e.g. "oai_dc", "eml-2.0.1", "eml-2.1.0"

   * @return

   */

  private boolean isIncludedDoctype(String doctype, String metadataPrefix) {

    boolean isIncluded = false;

    /*

     * If the metadataPrefix is "oai_dc", then include all catalog entries

     * in the list of identifiers. Else if the metadataPrefix is an EML

     * document type, then only include those catalog entries whose

     * document type matches that of the metadataPrefix. 

     */

    if (doctype != null && 

        (metadataPrefix.equals("oai_dc") ||

         (doctype.startsWith("eml://ecoinformatics.org/eml-") && 

          doctype.endsWith(metadataPrefix)

         )

        )

       ) {

      isIncluded = true;

    }

    return isIncluded;

  }

  /**

    Map<String, Object> listIdentifiersMap = new HashMap<String, Object>();

    ArrayList<String> headers = new ArrayList<String>();

    ArrayList<String> identifiers = new ArrayList<String>();

    filteredDateMap = filterDateMap(from, until, metadataPrefix);

    Iterator iterator = filteredDateMap.entrySet().iterator();

    int numRows = filteredDateMap.entrySet().size();

      String dateUpdated = (String) entryDateMap.getValue();

      String key = (String) entryDateMap.getKey();

      HashMap<String, String> nativeHeader = getNativeHeader(key);

      String[] headerArray = recordFactory.createHeader(nativeHeader);

     /* 

      * header, e.g.

      * 

      * <header>

      *   <identifier>urn:lsid:knb.ecoinformatics.org:knb-lter-gce:26</identifier>

      *   <datestamp>2009-03-11</datestamp>

      * </header>

      */

      String header = headerArray[0];

      headers.add(header);

      /*

       * identifier, e.g. urn:lsid:knb.ecoinformatics.org:knb-lter-gce:26

       */

      String identifier = headerArray[1]; 

      identifiers.add(identifier);

      count++;

    if (count == 0) { throw new NoItemsMatchException(); }

    Map<String, Object> listRecordsMap = new HashMap<String, Object>();

    ArrayList<String> records = new ArrayList<String>();

    filteredDateMap = filterDateMap(from, until, metadataPrefix);

    Iterator iterator = filteredDateMap.entrySet().iterator();

    int numRows = filteredDateMap.entrySet().size();

      try {

        String localIdentifier = (String) entryDateMap.getKey();

        HashMap<String, String> nativeItem =getMetacatDocument(localIdentifier);

        String record = constructRecord(nativeItem, metadataPrefix);

        records.add(record);

        count++;

      } 

      catch (IOException e) {

        e.printStackTrace();

        throw new OAIInternalServerError(e.getMessage());

    if (count == 0) { throw new NoItemsMatchException(); }

      listRecordsMap.put("resumptionMap", 

                         getResumptionMap(resumptionTokenSb.toString(), 

                                          numRows, 0

                                         )

                        );

    listRecordsMap.put("records", records.iterator()); 

   * Run a query of the Metacat database to load the catalog of EML documents.

   * For each EML document, we store its 'docid', 'doctype', and 'date_updated'

   * values.

   */

  public void loadCatalog() {

    Statement stmt;

    try {

      Connection conn = getConnection();

      if (conn != null) {

        stmt = conn.createStatement();                          

        ResultSet rs = stmt.executeQuery(QUERY);

        int documentCount = 0;

        while (rs.next()) {

          documentCount++;

          String docid = rs.getString("docid");

          String doctype = rs.getString("doctype");

          String dateUpdated = rs.getDate("date_updated").toString();

          docTypeMap.put(docid, doctype);

          dateMap.put(docid, dateUpdated);

        }

        logger.info("Number of documents in catalog: " + documentCount);

        stmt.close();   

        conn.close();

      }

    }

    catch(SQLException e) {

      logger.error("SQLException: " + e.getMessage());

    }

  }

  /**