Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.fmap.dal.feature;

import java.util.List;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.exception.DynFieldNotFoundException;

import org.gvsig.tools.lang.Cloneable;

import org.gvsig.tools.persistence.Persistent;

/**

 * A FeatureStoreTransform provides a mechanism for mapping a source FeatureType

 * to a target FeatureType, allowing to build different views (as in database

 * view) over different feature types even from different stores.

 *

 */

public interface FeatureStoreTransform

    extends Persistent, Cloneable {

    /**

     * Returns the default {@link FeatureType}.

     *

     * @return default {@link FeatureType}

     *

     * @throws DataException

     */

    public FeatureType getDefaultFeatureType() throws DataException;

    /**

     * Returns this FeatureStoreTransform's FeatureType(s)

     *

     * @return

     * @throws DataException

     */

    public List<FeatureType> getFeatureTypes() throws DataException;

    /**

     * Returns the original store {@link FeatureType} that replaces

     * targetFeatureType of this FeatureStoreTransform's

     *

     * @return source {@link FeatureType}

     */

    public FeatureType getSourceFeatureTypeFrom(FeatureType targetFeatureType);

    /**

     * Applies this transform between two features, copying the source data to

     * the target feature.

     *

     * @param source feature whose data will be used as source

     *

     * @param target feature in which the source data will be copied

     *

     * @throws DataException

     */

    public void applyTransform(Feature source, EditableFeature target)

        throws DataException;

    /**

     * Sets the FeatureStore to which this transform is applied.

     *

     * @param featureStore FeatureStore to which this transform is applied.

     */

    public void setFeatureStore(FeatureStore featureStore);

    /**

     * Returns the FeatureStore to which this transform belongs.

     *

     * @return FeatureStore to which this transform belongs.

     */

    public FeatureStore getFeatureStore();

    /**

     * Retruns true if this make changes of any attributes values or false if

     * only {@link FeatureType} definitions is changed.

     *

     * @return

     * @see {@link FeatureStoreTransforms#isTransformsOriginalValues()}

     *

     */

    public boolean isTransformsOriginalValues();

    public String getName();

    public String getDescription();

    /**

     * Sets the original metadata for this transform

     *

     * @param metadata

     */

    public void setSourceMetadata(DynObject metadata);

    public void setDynValue(String name, Object value) throws DynFieldNotFoundException;

    public boolean hasDynValue(String name);

    public Object getDynValue(String name) throws DynFieldNotFoundException;

    /**

     * This method must perform the necessary actions to set up the transformation.

     * 

     * It is called automatically when adding the transformation to the store 

     * and when the store is retrieved from the persistence.

     * 

     * @throws Exception 

     */

    public void  setUp() throws Exception ;

}