0.8.1-rc1/filemgr/src/main/java/org/apache/oodt/cas/filemgr/versioning/SingleFileBasicVersioner.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.cas.filemgr.versioning;

//JDK imports
import java.io.File;
import java.util.logging.Level;
import java.util.logging.Logger;

//OODT imports
import org.apache.oodt.cas.filemgr.structs.Product;
import org.apache.oodt.cas.filemgr.structs.Reference;
import org.apache.oodt.cas.filemgr.structs.exceptions.VersioningException;
import org.apache.oodt.cas.metadata.Metadata;

/**
 * @author mattmann
 * @version $Revision$
 * 
 * <p>
 * A {@link Versioner} that handles single file {@link Product}s by storing
 * them in <code>productTypeRepoPath/Filename</code>.
 * </p>
 * 
 */
public class SingleFileBasicVersioner implements Versioner {

    /* filename fields */
    public static final String FILENAME_FIELD = "Filename";

    /* our log stream */
    private static final Logger LOG = Logger.getLogger(SingleFileBasicVersioner.class
            .getName());

    /**
     * 
     */
    public SingleFileBasicVersioner() {
        super();
        // TODO Auto-generated constructor stub
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.apache.oodt.cas.filemgr.versioning.Versioner#createDataStoreReferences(gov.nasa.
     *      jpl.oodt.cas.filemgr.structs.Product,
     *      org.apache.oodt.cas.metadata.Metadata)
     */
    public void createDataStoreReferences(Product product, Metadata metadata)
            throws VersioningException {
        // we only handle single files, so throw exception if product is
        // heirarhical

        if (!product.getProductStructure().equals(Product.STRUCTURE_FLAT)) {
            throw new VersioningException(
                    "SingleFileVersioner: unable to version" + " Product: ["
                            + product.getProductName()
                            + "] with heirarchical/stream structure");
        }

        // we need the Filename Metadata parameter for this to work
        String filename = metadata.getMetadata(FILENAME_FIELD);

        if (filename == null || (filename != null && filename.equals(""))) {
            throw new VersioningException(
                    "SingleFileVersioner: unable to version without "
                            + "Filename metadata field specified!");
        }

        // now we need the product type repo path
        String productTypeRepoPathUri = product.getProductType()
                .getProductRepositoryPath();
        String productTypeRepoPath = VersioningUtils
                .getAbsolutePathFromUri(productTypeRepoPathUri);

        if (!productTypeRepoPath.endsWith("/")) {
            productTypeRepoPath += "/";
        }

        // final file location is:
        // /productTypeRepoPath/Filename

        String dataStorePath = productTypeRepoPath + filename;
        String dataStoreRef = new File(dataStorePath).toURI().toString();

        // get the first reference back
        // set its data store ref
        Reference ref = (Reference) product.getProductReferences().get(0);
        LOG.log(Level.INFO, "Generated data store ref: [" + dataStoreRef
                + "] from origRef: [" + ref.getOrigReference() + "]");
        ref.setDataStoreReference(dataStoreRef);

    }
}