| gvSIG desktop 1

package org.gvsig.data.vectorial;

public interface IFeatureAttributeDescriptor {

        public static final String TYPE_BYTE = "BYTE";

        public static final String TYPE_BOOLEAN = "BOOLEAN";

        public static final String TYPE_INT = "INTEGER";

        public static final String TYPE_LONG = "LONG";

        public static final String TYPE_FLOAT = "FLOAT";

        public static final String TYPE_DOUBLE = "DOUBLE";

        public static final String TYPE_STRING = "STRING";

        public static final String TYPE_DATE = "DATE";

        public static final String TYPE_TIME = "TIME";

        public static final String TYPE_TIMESTAMP = "TIMESTAMP";

        public static final String TYPE_GEOMETRY = "GEOMETRY";

        public static final String TYPE_OBJECT = "OBJECT";

        public static final String TYPE_FEATURE = "FEATURE";

        public static final String TYPE_EXPRESSION = "EXPRESSION";

        /**

     * 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.

     */

    String getName();

    /**

     * Returns a constant from {@link DataType}.  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.

     */

    String getDataType();

    /**

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

     * for the various constants of {@link DataType} for how to interpret this value.  As an

     * example, when the data type is {@link DataType#STRING STRING}, this value indicates

     * the maximum length of the string.

     */

    int getSize();

    /**

     * For attributes of type {@link DataType#DECIMAL DECIMAL}, this returns the maximum number

     * of places after the decimal point.  For other types, this must always return zero.

     */

    int getPrecision();

    /**

     * For attributes of type {@link DataType#OBJECT OBJECT}, this returns the Java {@link Class}

     * object that class or interface that all values of this attribute can be cast to.

     */

    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.

     */

    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.

     */

    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.

     */

    boolean isPrimaryKey();

        public int ordinal();

        String getSRS();

        int getGeometryType();

        Object getDefaultValue();

        String getExpression();

        /**

         * Checks attribute integrity

         */

        boolean isValid();

        /**

         * Clone this attribute

         *

         * @return IFeatureAttributeDescriptor

         */

        IFeatureAttributeDescriptor cloneAttribute();

        /**

         * Gets Intance to use for evalue the field value

         */

        IEvaluable getEvaluator();

        boolean isReadOnly();

}