org.protempa.datastore.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protempa-framework Show documentation

Protempa Framework is the core of Protempa.

There is a newer version: 5.2-Alpha-2

/*
 * #%L
 * Protempa Framework
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * 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.
 * #L%
 */
/**
 * The package org.eurekaclinical.datastore contains classes for
 * accessing external temporary and permanent stores. This is the only type-safe
 * way of getting handles to the {@link org.arp.javautil.DataStore} interface, via
 * the {@link org.arp.javautil.datastore.DataStoreFactory} class. If a new type
 * of store is needed, an appropriate class should be created and should
 * implement {@link org.eurekaclinical.datastore.DataStoreCreator}, which
 * defines two methods for building stores.
 * 
 * getPermanentStore returns a named store that will not be removed
 * once execution is finished. If a store with that name already exists, it may
 * be returned. Otherwise, a new store will be created.
 * 
 * newCacheStore returns a temporary store that will be destroyed
 * once execution is complete. Caches are not named, and the method is
 * guaranteed to return a new store each time it is called, so it is the
 * caller's responsibility to keep a reference to the store.
 */
package org.eurekaclinical.datastore;