| gvSIG desktop 1

package org.gvsig.fmap.dal.feature;

import java.text.DateFormat;

import org.gvsig.tools.evaluator.Evaluator;

public interface FeatureAttributeDescriptor {

        /**

         * Clone this attribute

         *

         * @return FeatureAttributeDescriptor

         */

        public FeatureAttributeDescriptor getCopy();

        /**

         * Returns the name of this attribute.  This is the name that can be used to

         * retrieve the value of an attribute and usually maps to either an XML

         * element name or a column name in a relational database.

         */

        public String getName();

        /**

         * Returns a constant from {@link FeatureAttributeDescriptor}. The return

         * value of this method indicates how the return values of {@link #getSize},

         * {@link #getPrecision}, and {@link #getObjectClass} should be interpreted.

         * For attributes whose maximum cardinality is greater than one, this should

         * return the data type of the individual elements of the collection.

         */

        public int getDataType();

        public String getDataTypeName();

        /**

         * Returns a number that indicates the size of a given attribute. See the

         * documentation for the various constants of

         * {@link FeatureAttributeDescriptor} for how to interpret this value. As an

         * example, when the data type is {@link FeatureAttributeDescriptor#STRING

         * STRING}, this value indicates the maximum length of the string.

         */

        public int getSize();

        /**

         * For attributes of type {@link FeatureAttributeDescriptor#DECIMAL DECIMAL}

         * , this returns the maximum number of places after the decimal point. For

         * other types, this must always return zero.

         */

        public int getPrecision();

        /**

         * For attributes of type {@link FeatureAttributeDescriptor#OBJECT OBJECT},

         * this returns the Java {@link Class} object that class or interface that

         * all values of this attribute can be cast to.

         */

        public Class getObjectClass();

        /**

         * Returns the minimum number of occurrences of this attribute on a given

         * feature.  The vast majority of data sources and data consumers will only

         * function with this value being zero or one.  If the minimum number of

         * occurrences is zero, this is equivalent, in SQL terms, to the attribute

         * being nillable.

         */

        public int getMinimumOccurrences();

        /**

         * Returns the maximum number of occurrences of this attribute on a given

         * feature.  The vast majority of data sources and data consumers will only

         * function with this value being one.  A value of {@link Integer#MAX_VALUE}

         * indicates that the maximum number of occurrences is unbounded.

         */

        public int getMaximumOccurrences();

        /**

         * Returns {@code true} if this attribute forms all or part of the unique identifying

         * value for the feature it is contained by.  The primary key attributes uniquely

         * identify this feature from other features of the same type.  This is different

         * from the {@linkplain Feature#getID feature's ID}, which must uniquely identify

         * the {@link Feature} among all feature types.

         */

        public boolean isPrimaryKey();

        public boolean allowNull();

        /**

         * Gets Intance to use for evalue the field value

         */

        public Evaluator getEvaluator();

        public boolean isReadOnly();

        public String getSRS();

        public int getGeometryType();

        public Object getDefaultValue();

        public DateFormat getDateFormat();

        public int getIndex();

}