EFeatureProperty.java

/**
 * <copyright>
 * </copyright>
 *
 * $Id$
 */
package org.geotools.data.efeature;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.geotools.data.Transaction;
import org.opengis.feature.Property;

/**
 * Generic interface for accessing {@link Property feature property} data.
 * 
 * <p>
 * The following members are supported:
 * <ul>
 * <li>{@link EFeatureProperty#getValue <em>Value</em>}</li>
 * <li>{@link EFeatureProperty#getValueType <em>Value Type</em>}</li>
 * <li>{@link EFeatureProperty#getData <em>Data</em>}</li>
 * <li>{@link EFeatureProperty#getDataType <em>Data Type</em>}</li>
 * </ul>
 * </p>
 * 
 * @param <V> - Actual {@link Property#getValue() property value} class.
 * @param <T> - Actual {@link Property property} class.
 * 
 * @see EFeaturePackage#getEFeatureProperty()
 * 
 * @author kengu
 */
public interface EFeatureProperty<V, T extends Property> {

    /**
     * Get property name
     */
    public String getName();
    
    /**
     * Get the {@link Property feature property} instance wrapped by this class instance.
     * 
     * @return the value of the '<em>Data</em>' attribute.
     * @see #setData(Property)
     */
    public T getData();

    /**
     * Set {@link Property feature property} instance wrapped by this class. </p>
     * 
     * @param value - new value of the '<em>Data</em>' attribute.
     * @throws NullPointerException If value is <code>null</code>.
     * @see #getData()
     */
    public void setData(T value);

    /**
     * Get the actual {@link Property feature property} class </p>
     * 
     * @return the value of the '<em>Data Type</em>' attribute.
     */
    public Class<T> getDataType();

    /**
     * Get the {@link Property#getValue() feature property value}.
     * 
     * @return the value of the '<em>Value</em>' attribute.
     * @see #setValue(Object)
     */
    public V getValue();

    /**
     * Set {@link Property feature property} instance wrapped by this class. </p>
     * 
     * @param value - new value of the '<em>Value</em>' attribute.
     * @throws NullPointerException If value is <code>null</code>.
     * @see #getValue()
     */
    public void setValue(V value);

    /**
     * Get the actual {@link Property#getValue() feature property value} class </p>
     * 
     * @return the value of the '<em>Value Type</em>' attribute.
     */
    public Class<V> getValueType();

    /**
     * Get the property {@link EStructureInfo structure} instance.
     * 
     * @return the value of the '<em>Structure</em>' attribute.
     */
    public EStructureInfo<?> getStructure();
    
    /**
     * Check if the value of this property is detached
     * from {@link #eObject()}.
     * @return <code>true</code> if value is detached.
     * @see {@link EFeatureHints#EFEATURE_VALUES_DETACHED}
     */
    public boolean isDetached();
    
    /**
     * Read values from {@link #eObject()}.
     * <p>
     * This is a convenience method which forwards to 
     * {@link #write(Transaction)} using {@link Transaction#AUTO_COMMIT}.
     * </p>
     * @return value just read into this property
     * @throws IllegalStateException If value is not {@link #isDetached() detached}
     */
    public V read() throws IllegalStateException;
    
    /**
     * Read values from {@link #eObject()}.
     * @param transaction {@link Transaction} instance 
     * @return value just read into this property
     * @throws IllegalStateException If value is not {@link #isDetached() detached}
     */
    public V read(Transaction transaction) throws IllegalStateException;
    
    
    /**
     * Write value to {@link #eObject()}
     * <p>
     * This is a convenience method which forwards to 
     * {@link #write(Transaction)} using {@link Transaction#AUTO_COMMIT}.
     * </p>
     * @return value just written to {@link #eObject()}
     * @throws IllegalStateException If value is not {@link #isDetached() detached}
     */
    public V write() throws IllegalStateException;
    
    /**
     * Write value to {@link #eObject()}
     * @param transaction {@link Transaction} instance 
     * @return value just written to {@link #eObject()}
     * @throws IllegalStateException If value is not {@link #isDetached() detached}
     */
    public V write(Transaction transaction) throws IllegalStateException;
    
    /**
     * Get the {@link EObject} with the {@link EStructuralFeature structural feature} containing the
     * {@link #getData() feature property}
     * 
     * @return the value of the '<em>Container</em>' attribute.
     */
    public EObject eObject();

    /**
     * Get the {@link EStructuralFeature structural feature} containing the {@link #getData()
     * feature property}
     * 
     * @return the value of the '<em>StructuralFeature</em>' attribute.
     */
    public EStructuralFeature getStructuralFeature();

} // EFeatureProperty