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.math.MathContext;

import java.text.DateFormat;

import java.util.Locale;

import org.cresques.cts.IProjection;

import org.gvsig.expressionevaluator.Expression;

import org.gvsig.fmap.dal.DataTypes;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.type.GeometryType;

import org.gvsig.timesupport.Interval;

import org.gvsig.tools.dataTypes.Coercion;

import org.gvsig.tools.dynobject.DynField_v2;

import org.gvsig.tools.evaluator.Evaluator;

import org.gvsig.tools.util.LabeledValue;

import org.gvsig.tools.dataTypes.CoercionContext;

import org.gvsig.tools.persistence.Persistent;

import org.gvsig.json.SupportToJson;

/**

 * A feature attribute descriptor contains information about one of the

 * attributes in a feature, such as its name, data type or precision.

 *

 * @author gvSIG team

 * @version $Id$

 */

public interface FeatureAttributeDescriptor

        extends DynField_v2, LabeledValue<FeatureAttributeDescriptor>, Persistent, SupportToJson {

  /**

   * Returns a clone of this attribute descriptor

   *

   * @return FeatureAttributeDescriptor A new copy of this

   */

  public FeatureAttributeDescriptor getCopy();

  /**

   * Returns the name of this attribute's data type.

   *

   * @return a string containing the name of this attribute's data type.

   */

  public String getDataTypeName();

  public boolean hasDataProfile();

  public String getDataProfileName();

  public DataProfile getDataProfile();

  /**

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

   * documentation for the various constants of {@link DataTypes} for how to

   * interpret this value. As an example, when the data type is

   * {@link DataTypes#STRING}, this value indicates the maximum length of the

   * string.

   *

   * @return an <code>int</code> indicating the size of the attribute.

   */

  public int getSize();

  /**

   * Return the designated column normal maximum width in characters.

   * 

   * @return 

   */

  public int getDisplaySize();

  /**

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

   * number of digits. For other types, this must always return zero.

   *

   * @return

   */

  public int getPrecision();

  /**

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

   * number of digits after the decimal point. For other types, this must always

   * return zero.

   *

   * @return

   */

  public int getScale();

  /**

   * For attributes of type {@link DataTypes#DECIMAL}, this returns the

   * MathContext associated to this. For other types return

   * {@link MathContext#UNLIMITED}.

   *

   * @return

   */

  public MathContext getMathContext();

  /**

   * Return a CoercionContext for this attribute.

   *

   * @return the CoercionContext

   */

  public CoercionContext getCoercionContext();

  /**

   * Return a Coercion to convert a value to the type of this attribute.

   *

   * @return the Coercion.

   */

  public Coercion getCoercion();

  /**

   * Returns the rounding mode to use when a value is converted to the

   * attribute's data type. It will only be used for Float, Double and Decimal

   * data types.

   *

   * @return

   */

  public int getRoundMode();

  /**

   * Returns the Locale associated with this attribute. It is usually used to

   * format and recognize dates and decimal numbers. The default Locale will be

   * <code>Locale. ENGLISH</code>

   *

   * @return

   */

  public Locale getLocale();

  /**

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

   * {@link Class} object that class or interface that all values of this

   * attribute can be cast to.

   *

   * @return

   */

  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.

   *

   * @return

   */

  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.

   *

   * @return

   */

  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#getReference()}, which

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

   *

   * @return

   */

  public boolean isPrimaryKey();

  /**

   * Indicates whether this attribute accepts null values.

   *

   * @return true if this attribute can be null, false if not.

   */

  public boolean allowNull();

  /**

   * Returns an evaluator that will be used to calculate the value of this

   * attribute

   * @return 

   */

  public Evaluator getEvaluator();

  /**

   * If this attribute is a {@link Geometry}, this method returns its Spatial

   * Reference System.

   *

   * @return the SRS if this attribute is a {@link Geometry}, otherwise this

   * method returns null.

   */

  public IProjection getSRS();

  /**

   * If this attribute is a {@link Geometry}, this method returns the specific

   * geometry type, as defined in {@link Geometry.TYPES}.

   *

   * @return One of {@link Geometry.TYPES}

   * @deprecated use {@link #getGeomType()} instead. To be removed in gvSIG 2.1.

   */

  public int getGeometryType();

  /**

   * If this attribute is a {@link Geometry}, this method returns the specific

   * geometry subtype, as defined in {@link Geometry.SUBTYPES}.

   *

   * @return One of {@link Geometry.SUBTYPES}

   * @deprecated use {@link #getGeomType()} instead. To be removed in gvSIG 2.1.

   */

  public int getGeometrySubType();

  /**

   * Returns the {@link GeometryType} of the attribute if it is a geometry.

   *

   * @return the geometry type

   */

  public GeometryType getGeomType();

  /**

   * If this attribute is of type Date, then this method returns the date format

   * set by the data store.

   *

   * @return a date format

   */

  public DateFormat getDateFormat();

  /**

   * Return the default value coerced to the data type of attribute. Return null

   * if can't coerce.

   *

   * @return default value or null.

   */

  public Object getDefaultValueCoerced();

  /**

   * Returns this attribute relative position within the {@link Feature}.

   *

   * @return an index

   */

  public int getIndex();

  /**

   * Returns additional information of the attribute

   *

   * @param infoName

   * @return info

   *

   */

  public String getAdditionalInfo(String infoName);

  /**

   * Returns if value is created automatically by the source

   * @return 

   */

  public boolean isAutomatic();

  /**

   * Gets if the attribute is a temporal attribute.

   *

   * @return <code>true</code> if is a temporal attribute

   */

  public boolean isTime();

  public Interval getInterval();

  /**

   * Return true if the attribute has and index in the table.

   *

   * @return true if indexed.

   */

  public boolean isIndexed();

  public boolean allowIndexDuplicateds();

  public boolean isIndexAscending();

  public boolean isForeingKey();

  public ForeingKey getForeingKey();

  /**

   * Gets if the attribute has a {@link FeatureAttributeGetter}.

   *

   * @return a FeatureAttributeGetter or null.

   * @deprecated use getFeatureAttributeGetterAndSetter

   */

  public FeatureAttributeGetter getFeatureAttributeGetter();

  /**

   * Sets the {@link FeatureAttributeGetter} that is used to update the

   * presentation of a field.

   *

   * @param featureAttributeGetter the {@link FeatureAttributeGetter} to set.

   * @deprecated use setFeatureAttributeGetterAndSetter

   */

  public void setFeatureAttributeGetter(FeatureAttributeGetter featureAttributeGetter);

  /**

   * Gets the attribute emulator associatted {@link FeatureAttributeEmulator} to

   * this attribute.

   *

   * @return a FeatureAttributeEmulator or null.

   */

  public FeatureAttributeEmulator getFeatureAttributeEmulator();

  /**

   * Return true if the attribute has an evaluator o an emulator.

   *

   * @return

   */

  public boolean isComputed();

  /**

   * Return the store associated to this attribute descriptor.

   *

   * @return the FeatureStore of the attribute descriptor.

   */

  public FeatureStore getStore();

  public FeatureType getFeatureType();

  public String[] getRequiredFieldNames();

  public void recentUsed();

  @Override

  public String getLocalizedShortLabel();

  @Override

  public String getLocalizedLabel();

  public String getLabelOfValue(Object value);

  public boolean hasOnlyMetadataChanges(FeatureAttributeDescriptor other);

  public boolean hasLabel();

  public boolean hasShortLabel();

  public boolean hasDescription();

  /**

   * Retrieve the value of the attribute "name".

   * 

   * @param name

   * @return 

   */

  public Object get(String name);

  public boolean hasConstantAvailableValues();

  public boolean isAvoidCachingAvailableValues();

  public Expression getAvailableValuesExpression();

  public FeatureAttributeDescriptor setAvailableValuesExpression(String expression);

  public FeatureAttributeDescriptor setAvailableValuesExpression(Expression expression);

  public boolean isInAvailableValues(Object valueToCheck);

  public boolean hasAvailableValues();

  public Expression getAvailableValuesFilter();

  public String getDefaultFormat();

  public String format(Object value);

}