+ * A Product's Ingest Status + *
+ * . + */ +public interface IngestStatus { + + enum Result { + SUCCESS, FAILURE, SKIPPED, PRECONDS_FAILED + } + + File getProduct(); + + Result getResult(); + + String getMessage(); + +} diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/crawler/ProductCrawler.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/crawler/ProductCrawler.java new file mode 100644 index 00000000..17344d66 --- /dev/null +++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/crawler/ProductCrawler.java @@ -0,0 +1,335 @@ +/* + * 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 gov.nasa.pds.harvest.search.oodt.crawler; + +import java.io.File; +import java.io.FileFilter; +import java.net.URL; +import java.util.Collections; +import java.util.List; +import java.util.Stack; +import java.util.Vector; +import java.util.logging.Level; +import java.util.logging.Logger; +import com.google.common.annotations.VisibleForTesting; +import gov.nasa.pds.harvest.search.oodt.filemgr.Ingester; +import gov.nasa.pds.harvest.search.oodt.metadata.Metadata; + + +/** + * An abstract base class for Product Crawling. This class provides methods to communicate with the + * file manager and parse met files that show how to ingest a particular Product into the File + * Manager. + * + * @author mattmann (Chris Mattmann) + * @author bfoster (Brian Foster) + */ +public abstract class ProductCrawler extends ProductCrawlerBean { + + /* our log stream */ + protected static Logger LOG = Logger.getLogger(ProductCrawler.class.getName()); + + // filter to only find directories when doing a listFiles + protected static FileFilter DIR_FILTER = new FileFilter() { + public boolean accept(File file) { + return file.isDirectory(); + } + }; + + // filter to only find product files, not met files + protected static FileFilter FILE_FILTER = new FileFilter() { + public boolean accept(File file) { + return file.isFile(); + } + }; + + protected List
+ * The core interface for a cache of {@link Product}s (identified by a particular
+ * uniqueElement) from a File Manager.
+ *
productName
+ * exists.
+ *
+ * @param productName The name of the {@link Product} to check for in the Cache.
+ * @return True if the {@link Product} is foudn in the Cache, False, otherwise.
+ */
+ boolean contains(String productName);
+
+ /**
+ * Specifies the {@link URL} to the File Manager to connect this Cache to.
+ *
+ * @param fmUrl The {@link URL} of the File Manager to cache {@link Product}s from.
+ */
+ void setFileManager(URL fmUrl);
+
+ /**
+ *
+ * @return The size of the current {@link Product} cache.
+ */
+ int size();
+
+ /**
+ * Synchronizes this Cache with the File Manager specified by the {@link #setFileManager(URL)}
+ * method.
+ *
+ * @param uniqueElementProductTypeNames The {@link List} {@link ProductType}s to cache
+ * {@link Product}s from.
+ * @throws CacheException If there is any error.
+ */
+ void sync(List+ * A Factory class for creating {@link Cache}s + *
+ * . + */ +public interface CacheFactory { + + /** + * Create a new {@link Cache}. + * + * @return A new {@link Cache}, constructed by the implementing Factory. + * @throws InstantiationException If the the particular {@link Cache} can not be created for some + * reason. + */ + Cache createCache() throws InstantiationException; + +} diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/Catalog.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/Catalog.java new file mode 100644 index 00000000..562f7077 --- /dev/null +++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/Catalog.java @@ -0,0 +1,272 @@ +/* + * 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 gov.nasa.pds.harvest.search.oodt.filemgr; + +// JDK imports +import java.util.List; +import gov.nasa.pds.harvest.search.oodt.filemgr.exceptions.CatalogException; +import gov.nasa.pds.harvest.search.oodt.metadata.Metadata; +import gov.nasa.pds.harvest.search.oodt.structs.Product; +import gov.nasa.pds.harvest.search.oodt.structs.ProductPage; +import gov.nasa.pds.harvest.search.oodt.structs.ProductType; +import gov.nasa.pds.harvest.search.oodt.structs.Query; + +/** + * @author mattmann + * @author bfoster + * @version $Revision$ + * + *+ * A Catalog is the front end object interface for a back end peristance layer for storing + * product references and metadata. Classes implementing this interface implement methods + * to retrieve and store product references and metadata from a particular backend + * repository. + *
+ * + */ +public interface Catalog extends Pagination { + + String X_POINT_ID = Catalog.class.getName(); + + /** + *
+ * Ingests {@link Metadata} into the metadata store, and associates it with the given
+ * productId.
+ *
+ * Removes {@link Metadata} from the metadata store, and disassociates it from the given
+ * productId.
+ *
+ * Adds a Product to the Catalog. + *
+ * + * @param product The {@link Product} to add. + * @throws CatalogException If any error occurs during the add. + */ + void addProduct(Product product) throws CatalogException; + + /** + *+ * Modifies an existing Product within the Catalog. + *
+ * + * @param product The new {@link Product} information to modify the existing Product with. + * @throws CatalogException If any error occurs. + */ + void modifyProduct(Product product) throws CatalogException; + + /** + *+ * Removes a {@link Product} from the Catalog. + *
+ * + * @param product The product to remove. + * @throws CatalogException If any error occurs. + */ + void removeProduct(Product product) throws CatalogException; + + /** + *
+ * Persists the transferStatus attribute of the given {@link Product} to the Catalog.
+ *
+ * @param product The Product whose transfer status will be persisted. The caller should make sure
+ * that the product ID field is set.
+ * @throws CatalogException
+ */
+ void setProductTransferStatus(Product product) throws CatalogException;
+
+ /**
+ *
+ * Adds the specified {@link List} of {@link Reference}s to the {@link Catalog}, and associates
+ * them with this {@link Product} specified by its productId.
+ *
+ * Gets a {@link Product}, with the specified productId.
+ *
+ * Gets a {@link Product} with the specified productName.
+ *
+ * Gets the {@link Reference}s associated with this Product. + *
+ * + * @param product The {@link Product} to obtain the References for. + * @return A {@link List} of {@link Reference}s, associated with the specified Product. + * @throws CatalogException + */ + List getProductReferences(Product product) throws CatalogException; + + /** + *+ * Gets all the {@link Product}s in the {@link Catalog}. + *
+ * + * @return A {@link List} of {@link Product}s in the {@link Catalog}. + * @throws CatalogException If any error occurs. + */ + List+ * Gets the {@link Product}s associated with the specified ProductType in the {@link Catalog}. + *
+ * + * @param type The {@link ProductType} to obtain the {@link Product}s for. + * @return A {@link List} of {@link Product}s that are associated with the specified productType + * in the {@link Catalog}. + * @throws CatalogException If any error occurs. + */ + List+ * Gets the Metadata for a given Product. + *
+ * + * @param product The {@link Product} to obtain the Metadata for. + * @return The {@link Metadata} for the givenproductId.
+ *
+ * @throws CatalogException If any error occurs.
+ */
+ Metadata getMetadata(Product product) throws CatalogException;
+
+ /**
+ * + * Gets a reduced set of metadata for a give Product. + *
+ * + * @param product The {@link Product} to obtain the Metadata for. + * @param elements The set of metadata elements of interest. + * @return The reduced {@link Metadata} for the givenproductId.
+ * @throws CatalogException If any error occurs.
+ */
+ Metadata getReducedMetadata(Product product, List+ * Queries the Catalog with the specified {@link Query} + *
+ * . + * + * @param query The set of criteria by which to query the Catalog. + * @param type The {@link ProductType} that should be queried. + * @return A {@link List} of String product IDs that can be used to retrieve products that match + * the query. + * @throws CatalogException If any error occurs. + */ + List+ * Performs a query against the underlying {@link Catalog}, and then properly formulates a page of + * results to send back to the user. This method is useful when you would like to conserve memory + * and not send back the entire list of results, nor load them into memory. Of course, this method + * assumes that queries are deterministic, i.e., the same query issued 2x within a paginating + * session will produce the same set of results to paginate. + *
+ * + * @param query The query to perform against the underlying Catalog. + * @param type The {@link ProductType} that you are querying for. + * @param pageNum The number of the {@link ProductPage} to return back to the user. + * @return The requested {@link ProductPage} of results. + * @throws CatalogException If any error occurs. + */ + ProductPage pagedQuery(Query query, ProductType type, int pageNum) throws CatalogException; + + /** + *
+ * Gets the top N most recent products that have been cataloged.
+ *
+ * Gets the top N most recent products that have been cataloged for the given
+ * {@link ProductType}.
+ *
+ * A Factory interface for creating {@link Catalog}s. + *
+ * + */ +public interface CatalogFactory { + + /** + * @return A new {@link Catalog} object implementation. + */ + Catalog createCatalog(); +} diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/CrawlerActionPhases.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/CrawlerActionPhases.java new file mode 100644 index 00000000..5ad21b61 --- /dev/null +++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/CrawlerActionPhases.java @@ -0,0 +1,46 @@ +/* + * 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 gov.nasa.pds.harvest.search.oodt.filemgr; + +/** + * Supported Crawler Phases. + * + * @author mattmann (Chris Mattmann) + * @author bfoster (Brian Foster) + */ +public enum CrawlerActionPhases { + PRE_INGEST("preIngest"), POST_INGEST_SUCCESS("postIngestSuccess"), POST_INGEST_FAILURE( + "postIngestFailure"); + + private String name; + + CrawlerActionPhases(String name) { + this.name = name; + } + + public String getName() { + return name; + } + + public static CrawlerActionPhases getPhaseByName(String name) { + for (CrawlerActionPhases phase : CrawlerActionPhases.values()) { + if (phase.getName().equals(name)) { + return phase; + } + } + return null; + } +} diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/DataTransfer.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/DataTransfer.java new file mode 100644 index 00000000..0514f0b9 --- /dev/null +++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/DataTransfer.java @@ -0,0 +1,65 @@ +/* + * 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 gov.nasa.pds.harvest.search.oodt.filemgr; + +// JDK imports +import java.io.File; +import java.io.IOException; +import java.net.URL; +import gov.nasa.pds.harvest.search.oodt.filemgr.exceptions.DataTransferException; +import gov.nasa.pds.harvest.search.oodt.structs.Product; + +/** + * @author mattmann + * @version $Revision$ + * + *+ * Objects implementing this interface define how to transfer products to the + * {@link DataStore} repository. + *
+ * + */ +public interface DataTransfer { + /* extension point ID */ + String X_POINT_ID = DataTransfer.class.getName(); + + /** + * + * @param url The URL to the File Manager that this transferer will be transferring Products to. + */ + void setFileManagerUrl(URL url); + + /** + * + * @param product The product that is being transferred. The product should have both its + * origFileLocation, as well as its dataStoreRefs filled in to perform the transfer. + * @throws DataTransferException If a general error occurs during the transfer. + * @throws IOException If there is an IO eerror when performing the transfer. + */ + void transferProduct(Product product) throws DataTransferException, IOException; + + /** + * Requires that the data store reference be set, nothing else is used + * + * @param product The product whose data store reference will be copied + * @param directory The directory where the data store reference will be copied to + * @throws DataTransferException If a general error occurs during the transfer. + * @throws IOException If there is an IO eerror when performing the transfer. + */ + void retrieveProduct(Product product, File directory) throws DataTransferException, IOException; + + void deleteProduct(Product product) throws DataTransferException, IOException; +} diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/DataTransferFactory.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/DataTransferFactory.java new file mode 100644 index 00000000..c519ee88 --- /dev/null +++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/DataTransferFactory.java @@ -0,0 +1,33 @@ +/* + * 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 gov.nasa.pds.harvest.search.oodt.filemgr; + +/** + * @author mattmann + * @version $Revision$ + * + *+ * A Factory for creating {@link DataTransfer} implementation objects. + *
+ * + */ +public interface DataTransferFactory { + + /** + * @return A new {@link DataTransfer} implementation. + */ + DataTransfer createDataTransfer(); +} diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/FilemgrMetExtractor.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/FilemgrMetExtractor.java new file mode 100644 index 00000000..99702004 --- /dev/null +++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/FilemgrMetExtractor.java @@ -0,0 +1,51 @@ +/* + * 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 gov.nasa.pds.harvest.search.oodt.filemgr; + +// JDK imports +import java.util.Properties; +import gov.nasa.pds.harvest.search.oodt.filemgr.exceptions.MetExtractionException; +import gov.nasa.pds.harvest.search.oodt.metadata.Metadata; +import gov.nasa.pds.harvest.search.oodt.structs.Product; + +/** + * @author mattmann + * @version $Revision$ + * + *+ * The core interface for {@link Metadata} extraction on the File Manager server side. + *
+ * . + */ +public interface FilemgrMetExtractor { + + /** + * Extracts {@link Metadata} from the given {@link Product}. + * + * @param product The given {@link Product}. + * @param met The original {@link Metadata} provided during ingestion. + * @return Extracted {@link Metadata} derived from the existing {@link Metadata} and + * {@link Product} provided. + */ + Metadata extractMetadata(Product product, Metadata met) throws MetExtractionException; + + /** + * Sets the configuration for this Metadata extractor. + * + * @param props The {@link Properties} object to configure this Metadata extractor with. + */ + void configure(Properties props); +} diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/GenericFileManagerObjectFactory.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/GenericFileManagerObjectFactory.java new file mode 100644 index 00000000..a6cbce7f --- /dev/null +++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/GenericFileManagerObjectFactory.java @@ -0,0 +1,295 @@ +/* + * 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 gov.nasa.pds.harvest.search.oodt.filemgr; + +import java.util.logging.Level; +import java.util.logging.Logger; +import gov.nasa.pds.harvest.search.oodt.structs.query.FilterAlgor; +import gov.nasa.pds.harvest.search.oodt.structs.query.VersionConverter; +import gov.nasa.pds.harvest.search.oodt.structs.type.TypeHandler; + +/** + * @author mattmann + * @author bfoster + * @version $Revision$ + * + *+ * Generic object creation utilities for FileManager objects from their interface class + * names. + *
+ * + */ +public final class GenericFileManagerObjectFactory { + + /* our log stream */ + private static final Logger LOG = + Logger.getLogger(GenericFileManagerObjectFactory.class.getName()); + + private GenericFileManagerObjectFactory() throws InstantiationException { + throw new InstantiationException("Don't construct final factory classes!"); + } + + /** + *
+ * Constructs a new {@link DataTransfer} from the specified serviceFactory.
+ *
+ * Constructs a new {@link RepositoryManager} from the specified serviceFactory.
+ *
+ * Constructs a new {@link Catalog} from the specified serviceFactory.
+ *
+ * Creates a {@link ValidationLayer} from the specified serviceFactory.
+ *
+ * Constructs a new {@link Versioner} from the specified className.
+ *
+ * An interface for ingesting {@link Product}s + *
+ * . + */ +public interface Ingester { + + /** + * Ingests a {@link Product} to the file manager service object identified by the given + * {@link URL} parameter. The product {@link Metadata} is extracted dynamically using the provided + * {@link MetExtractor} interface. + * + * @param fmUrl The {@link URL} pointer to the file manager service. + * @param prodFile The {@link File} pointer to the product file. + * @param extractor The given {@link MetExtractor} to use to extract {@link Metadata} from the + * {@link Product}. + * @param metConfFile A Config{@link File} for the {@link MetExtractor}. + * @return The ID returned by the file manager for the newly ingested product. + * @throws IngestException If there is an error ingesting the {@link Product} + */ + String ingest(URL fmUrl, File prodFile, MetExtractor extractor, File metConfFile) + throws IngestException; + + /** + * Ingests a {@link Product} to the file manager service object identified by the given + * {@link URL} parameter. The product {@link Metadata} is provided a priori. + * + * @param fmUrl The {@link URL} pointer to the file manager service. + * @param prodFile The {@link File} pointer to the product file. + * @param met The given {@link Metadata} object already extracted from the {@link Product}. + * @return The ID returned by the file manager for the newly ingested product. + * @throws IngestException If there is an error ingesting the {@link Product} + */ + String ingest(URL fmUrl, File prodFile, Metadata met) throws IngestException; + + /** + * + * @param fmUrl The {@link URL} pointer to the file manager service. + * @param prodFiles A {@link List} of {@link String} filePaths pointing to {@link Product} files + * to ingest. + * @param extractor The given {@link MetExtractor} to use to extract {@link Metadata} from the + * {@link Product}s. + * @param metConfFile A Config{@link File} for the {@link MetExtractor}. + * @throws IngestException If there is an error ingesting the {@link Product}s. + */ + void ingest(URL fmUrl, ListFilename.
+ *
+ * @param prodFile The {@link File} to check for existance of within the file manager at given
+ * {@link URL}.
+ * @url The {@link URL} pointer to the file manager service.
+ * @return
+ */
+ boolean hasProduct(URL fmUrl, File prodFile) throws CatalogException;
+
+ /**
+ * Checks the file manager at the given {@link URL} to see whether or not it knows about the
+ * provided {@link Product} with the given productName parameter. To do this, it uses
+ * the provided productName key as the {@link Metadata} key to search for in the
+ * catalog.
+ *
+ * @param fmUrl The {@link URL} pointer to the file manager service.
+ * @param productName The {@link Product} to search for, identified by its (possibly not unique)
+ * name.
+ * @return True if the file manager has the product, false otherwise.
+ */
+ boolean hasProduct(URL fmUrl, String productName) throws CatalogException;
+
+}
diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/Pagination.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/Pagination.java
new file mode 100644
index 00000000..549ea958
--- /dev/null
+++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/Pagination.java
@@ -0,0 +1,62 @@
+/*
+ * 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 gov.nasa.pds.harvest.search.oodt.filemgr;
+
+import gov.nasa.pds.harvest.search.oodt.structs.ProductPage;
+import gov.nasa.pds.harvest.search.oodt.structs.ProductType;
+
+/**
+ * @author mattmann
+ * @version $Revision$
+ *
+ * + * An interface for pagination of {@link org.apache.oodt.cas.filemgr.structs.Product} + * {@link java.util.List}s.. + *
+ * + */ +public interface Pagination { + + /** + * @param type The ProductType to obtain the first {@link ProductPage} for. + * @return The first page of products for a particular {@link ProductType}. + */ + ProductPage getFirstPage(ProductType type); + + /** + * + * @param type The ProductType to obtain the last {@link ProductPage} for. + * @return The last page of products for a particular {@link ProductType}. + */ + ProductPage getLastProductPage(ProductType type); + + /** + * + * @param type The ProductType to obtain the next page for, given thecurrentPage.
+ * @param currentPage The current page that tells the function what the next page to obtain is.
+ * @return The next page in the ProductType product list, given the currentPage.
+ */
+ ProductPage getNextPage(ProductType type, ProductPage currentPage);
+
+ /**
+ *
+ * @param type The ProductType to obtain the previous page for, given the
+ * currentPage.
+ * @param currentPage The currentPage that tells the function what the previous page to obtain is.
+ * @return The previous page in the ProductType product list, given the currentPage.
+ */
+ ProductPage getPrevPage(ProductType type, ProductPage currentPage);
+}
diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/QueryResult.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/QueryResult.java
new file mode 100644
index 00000000..5e5d10c4
--- /dev/null
+++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/QueryResult.java
@@ -0,0 +1,137 @@
+/*
+ * 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 gov.nasa.pds.harvest.search.oodt.filemgr;
+
+import java.util.ArrayList;
+import java.util.List;
+import org.springframework.util.StringUtils;
+import gov.nasa.pds.harvest.search.oodt.metadata.Metadata;
+import gov.nasa.pds.harvest.search.oodt.structs.Product;
+
+// OODT imports
+
+/**
+ *
+ * @author bfoster
+ * @version $Revision$
+ *
+ * + * A combination of a Product and its Metadata + *
+ */
+public class QueryResult {
+
+ private Product product;
+ private Metadata metadata;
+ private String toStringFormat;
+
+ public QueryResult(Product product, Metadata metadata) {
+ this.metadata = metadata;
+ this.product = product;
+ }
+
+ public Product getProduct() {
+ return this.product;
+ }
+
+ public void setProduct(Product product) {
+ this.product = product;
+ }
+
+ public Metadata getMetadata() {
+ return this.metadata;
+ }
+
+ public void setMetadata(Metadata metadata) {
+ this.metadata = metadata;
+ }
+
+ public String getToStringFormat() {
+ return this.toStringFormat;
+ }
+
+ public void setToStringFormat(String toStringFormat) {
+ this.toStringFormat = toStringFormat;
+ }
+
+ public String toString() {
+ return convertMetadataToString(this.metadata, this.toStringFormat);
+ }
+
+ private static String convertMetadataToString(Metadata metadata, String format) {
+ if (format == null) {
+ return concatMetadataIntoString(metadata);
+ }
+ String outputString = format;
+ for (String key : metadata.getAllKeys()) {
+ outputString = outputString.replaceAll("\\$" + key,
+ StringUtils.collectionToCommaDelimitedString(metadata.getAllMetadata(key)));
+ }
+ return outputString;
+ }
+
+ private static String concatMetadataIntoString(Metadata metadata) {
+ List
+// * A Factory for constructing {@link RemoteDataTransferer} objects.
+// *
+// * An implementation of the {@link DataTransfer} interface that transfers files to a remote
+// * file manager over XML-RPC, using the File Manager Client.
+// *
+ * Adds a ProductType to the RepositoryManager. + *
+ * + * @param productType The {@link ProductType} to add. + * @throws RepositoryManagerException + */ + void addProductType(ProductType productType) throws RepositoryManagerException; + + /** + *
+ * Modifies a ProductType in the RepositoryManager with the specified ID field of the
+ * productType.
+ *
+ * Removes a ProductType from the RepositoryManager + *
+ * . + * + * @param productType The productType to remove. + * @throws RepositoryManagerException If any error occurs during the removal. + */ + void removeProductType(ProductType productType) throws RepositoryManagerException; + + /** + *
+ * Gets a {link ProductType} from the RepositoryManager identified by its
+ * productTypeId.
+ *
productTypeId.
+ * @throws RepositoryManagerException If any error occurs.
+ */
+ ProductType getProductTypeById(String productTypeId) throws RepositoryManagerException;
+
+ /**
+ *
+ * Gets a {@link ProductType} specified by its productTypeName, from the
+ * RepositoryManager.
+ *
+ * Gets all the {@link ProductType}s from the repository. + *
+ * + * @return A {@link List} of {@link ProductType}s from the repository. + * @throws RepositoryManagerException If any error occurs. + */ + List+ * A Factory interface for creating {@link RepositoryManager} objects. + *
+ * + */ +public interface RepositoryManagerFactory { + + RepositoryManager createRepositoryManager(); +} diff --git a/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/ValidationLayer.java b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/ValidationLayer.java new file mode 100644 index 00000000..86fb0ddc --- /dev/null +++ b/src/main/java/gov/nasa/pds/harvest/search/oodt/filemgr/ValidationLayer.java @@ -0,0 +1,124 @@ +/* + * 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 gov.nasa.pds.harvest.search.oodt.filemgr; + +// JDK imports +import java.util.List; +import gov.nasa.pds.harvest.search.oodt.filemgr.exceptions.ValidationLayerException; +import gov.nasa.pds.harvest.search.oodt.structs.Element; +import gov.nasa.pds.harvest.search.oodt.structs.ProductType; + +/** + * @author mattmann + * @author bfoster + * @version $Revision$ + * + *+ * The Validation Layer for the File Manager, allowing {@link Element}s to be mapped to + * {@link ProductType}s. + *
+ * + */ +public interface ValidationLayer { + + /** + *
+ * Adds the Element to the ValidationLayer.
+ *
+ * Modifies an existing {@link Element} in the ValidationLayer. + *
+ * + * @param element The new {@link Element} data to update. + * @throws ValidationLayerException If any error occurs. + */ + void modifyElement(Element element) throws ValidationLayerException; + + /** + *+ * Removes a metadata {@link Element} from the ValidationLayer. + * + * @param element The element to remove. + * @throws ValidationLayerException If any error occurs. + */ + void removeElement(Element element) throws ValidationLayerException; + + /** + *
+ * Adds the specified element to the {@link ProductType} specified by its
+ * productTypeId.
+ *
+ * @param type The {@link ProductType} to associate the metadata Element with.
+ * @param element The {@link Element} to associate with the ProductType.
+ * @throws ValidationLayerException If any error occurs.
+ */
+ void addElementToProductType(ProductType type, Element element) throws ValidationLayerException;
+
+ /**
+ *
+ * Removes a metadata {@link Element} from the specified productTypeId.
+ *
element with.
+ * @param element The element whose association will be removed from the specified ProductType.
+ * @throws ValidationLayerException If any error occurs.
+ */
+ void removeElementFromProductType(ProductType type, Element element)
+ throws ValidationLayerException;
+
+ /**
+ *
+ * Returns a {@link List} of {@link Element}s corresponding to the given ProductType.
+ *
+ * @param type The product type to retrieve the metadata {@link Element}s for.
+ * @return A {@link List} of {@link Element}s corresponding to the given ProductType.
+ * @throws ValidationLayerException If any error occurs.
+ */
+ List
+ * A Factory for creating {@link ValidationLayer}s.
+ *
+ * This interface defines a versioning scheme for generating the DataStore references for
+ * the items in a {@link Product}.
+ *
+ * A factory class for creating File Manager structures suitable for transfer over the
+ * XML-RPC pipe, and for reading objects from the XML-RPC pipe into File Manager structs.
+ *