/org.gvsig.tools/library/trunk/org.gvsig.tools/org.gvsig.tools.lib/src/main/java/org/gvsig/tools/dynobject/DynField.java - Diff - Library: org.gvsig.tools - gvSIG

Revision 212 org.gvsig.tools/library/trunk/org.gvsig.tools/org.gvsig.tools.lib/src/main/java/org/gvsig/tools/dynobject/DynField.java

     public interface DynField {
     	/**
     	 * If the field value can be any possible value, for its type.
     	 * Return the name of the field.
+    	 *
     	 * @deprecated now autodetect the mode of use
     	 * @return name of the field
     	 */
     	static final int ANY = 1;
     	public String getName();
     	/**
     	 * If the field value must be one of a list of posible values.
     	 * Return the type used in this field.
     	 * The values of type is the same of {@link DataTypes}
+    	 *
     	 * @deprecated usado automaticamente al asignar AvailableValues
     	 * @return
     	 */
         static final int CHOICE = 2;
     	public int getType();
     	/**
     	 * If the field value must pertain to a range of possible values.
     	 * Return the subtype associated to this field.
     	 * The subtype is a string used for the cliente of the
     	 * field.
+    	 *
     	 * @deprecated usado automaticamente al asignar minValue/maxValue
     	 * When the field is of type #{@link DataTypes#DYNOBJECT},
     	 * the subtype are the fullname of the DynClass.
+    	 *
     	 * @return the subtype of the field.
     	 */
         static final int RANGE = 3;
     	String getName();
     	int getType();
     	String getSubtype();
     	public String getSubtype();
     	String getDescription();
     	/**
     	 * Return the descripcion associated to this field.
+    	 *
     	 * @return the description of the field.
     	 */
     	public String getDescription();
     	Object getDefaultValue();
     	/**
     	 * Return the default value used in creation of new objects
     	 * with this field.
+    	 *
     	 * @return defaulr value to use for this field.
     	 */
     	public Object getDefaultValue();
     	boolean isMandatory();
     	/**
     	 * Return a string that identify a group for this field.
     	 * The groups are defined by the client of the field.
+    	 *
     	 * @return the group of the field
     	 */
     	public String getGroup();
     	String getGroup();
     	int getOder();
     	/**
     	 * Return the ordinal that identify the order of this field
     	 * in the {@link DynObject}.
+    	 *
     	 * @return the order of field in the {@link DynObject}
     	 */
     	public int getOder();
     	/**
     	 * Return true if this field is mandatory.
+    	 *
     	 */
     	public boolean isMandatory();
     	/**
     	 * Returns if the field is persistent or volatile. The meaning of being
     	 * persistent depends on how is persisted, but any persistence mechanism
     	 * must avoid persisting this field value.
+    	 *
     	 * @return if the field is to be persisted or not
     	 */
     	boolean isPersistent();
     	/**
     	 * Inform if this field can be visible or not for the user.
     	 * This value don't affect the access through the API.
+    	 *
     	 * @return true if the field is hidden for the user.
     	 */
     	boolean isHidden();
     	/**
     	 * @deprecated don't use, check minValue/maxValue and getAvailableValues instead
     	 * Returns if the field is readOnly or not. The meaning of being
     	 * readOnly allows to know if the user input to any graphic component associated
     	 * to this field should be allowed or not.
+    	 *
     	 * @return if the graphic component associated to this field should be readOnly or not
     	 */
     	int getTheTypeOfAvailableValues(); // SINGLE, CHOICE o RANGE
     	public boolean isReadOnly();
     	/**
     	 * Return true if the value of this field is a container.
     	 * This method uses the same criteria of the {@link DataType}
+    	 *
     	 * @return true if the field type is a container
     	 */
     	public boolean isContainer();
     	DynObjectValueItem[] getAvailableValues();
     	/**
     	 * Return the available values for this field.
     	 * When assign a value to the field, this value need that
     	 * exists in this list.
+    	 *
     	 * @return an array of the available values for the field.
     	 */
     	public DynObjectValueItem[] getAvailableValues();
     	Object getMinValue();
     	public Object getMinValue();
     	Object getMaxValue();
     	public Object getMaxValue();
     	/**
     	 * Return the java class of the value of the field.
+    	 *
     	 * @return the class of the value
     	 */
     	Class getClassOfValue();
     	/**
     	 * If the field is a container (List, Map or Set) return
     	 * the java class of its items.
+    	 *
     	 * @return the class of the items
     	 */
     	Class getClassOfItems();
     	/**
     	 * Sets the description asociated to this field.
+    	 *
     	 * @param description
+    	 *
     	 * @return this same {@link DynField} object
     	 */
     	DynField setDescription(String description);
     	/**
     	 * Sets the type of the field.
     	 * The values used are the specified in {@link DataTypes}.
+    	 *
     	 * This method assign the default values of the type for
     	 * "ClassOfValue" and "subType".
+    	 *
     	 * @param type
+    	 *
     	 * @return this same {@link DynField} object
     	 */
     	DynField setType(int type);
     	/**
     	 * Cuando el tipo sea  #{@link DataTypes#DYNOBJECT}, el
     	 * subtype sera el fullname de la DynStruct.
     	 * Strings used as subtype for this field.
     	 * This value is used by the client of the object.
+    	 *
     	 * When the field is a #{@link DataTypes#DYNOBJECT},
     	 * the subtype is the fullname of the DynStruct.
+    	 *
     	 * @param subtype
     	 * @return
+    	 *
     	 * @return this same {@link DynField} object
     	 */
     	DynField setSubtype(String subtype);
     	DynField setDefaultDynValue(Object defaultValue);
     	DynField setMandatory(boolean mandatory);
     	/**
     	 * Set the default value used for this field when a new
     	 * object with this field is created.
+    	 *
     	 * @param defaultValue
+    	 *
     	 * @return this same {@link DynField} object
     	 */
     	DynField setDefaultValue(Object defaultValue);
     	DynField setGroup(String groupName);
     	DynField setOrder(int order);
     	DynField setMandatory(boolean mandatory);
     	DynField setHidden(boolean hidden);
     	DynField setOrder(int order);
     	/**
     	 * Sets if the field must be persisted or not.
     	 * @see #isPersistent()
-...
     	 */
     	DynField setPersistent(boolean persistent);
     	/**
     	 * @deprecated don't use, set minValue/maxValue and availableValues instead
     	 */
     	DynField setTheTypeOfAvailableValues(int type);
     	DynField setAvailableValues(DynObjectValueItem[] values);
     	DynField setAvailableValues(List values);
-...
     	DynField setMaxValue(Object maxValue);
     	/**
     	 * When a field is type object, this is the class of the object.
     	 * If field type is List, Set or Map, this class is the class of items.
     	 * Sets the class used for the values of the field.
+    	 *
     	 * @param theClass
+    	 *
     	 * @param theClass
     	 * @return this same {@link DynField} object
+    	 *
     	 * @throws DynFieldIsNotAContainerException
     	 */
     	DynField setClassOfValue(Class theClass) throws DynFieldIsNotAContainerException;
     	/**
     	 * Validate that the value match the properties of the field.
     	 * If field type is List, Set or Map, this class is the class of items.
+    	 *
     	 * @param value
     	 * @throws DynFieldValidateException
     	 * @param theClass
+    	 *
     	 * @return this same {@link DynField} object
+    	 *
     	 * @throws DynFieldIsNotAContainerException
     	 */
     	void validate(Object value) throws DynFieldValidateException;
     	DynField setClassOfItems(Class theClass) throws DynFieldIsNotAContainerException;
     	/**
     	 * Force the type of value to the type of the field.
+    	 *
     	 * @param value
     	 * @return new value
     	 * @throws CoercionException
     	 * Sets if the field is readOnly or not. The meaning of being
     	 * readOnly allows to know if the user input to any graphic component associated
     	 * to this field should be allowed or not.
     	 * @param isReadOnly
     	 *    if the graphic component associated to this field should be readOnly or not
+    	 *
     	 * @return DynField that define the type of elements.
     	 */
     	Object coerce(Object value) throws CoercionException;
     	public DynField setReadOnly(boolean isReadOnly);
     	/**
     	 * When a field is of type container, this method return a DynClass
     	 * that define the type of elements.
-...
     	 */
     	public DynField setElementsType(DynStruct type) throws DynFieldIsNotAContainerException ;
     	/**
     	 * Returns if the field is readOnly or not. The meaning of being
     	 * readOnly allows to know if the user input to any graphic component associated
     	 * to this field should be allowed or not.
     	 * @return if the graphic component associated to this field should be readOnly or not
     	 * Validate that the value match the properties of the field.
+    	 *
     	 * @param value
     	 * @throws DynFieldValidateException
     	 */
     	public boolean isReadOnly();
     	void validate(Object value) throws DynFieldValidateException;
     	/**
     	 * Sets if the field is readOnly or not. The meaning of being
     	 * readOnly allows to know if the user input to any graphic component associated
     	 * to this field should be allowed or not.
     	 * @param isReadOnly
     	 *    if the graphic component associated to this field should be readOnly or not
+    	 *
     	 * @return DynField that define the type of elements.
     	 * Force the type of value to the type of the field.
+    	 *
     	 * @param value
     	 * @return new value
     	 * @throws CoercionException
     	 */
     	public DynField setReadOnly(boolean isReadOnly);
     	public boolean isContainer();
     	Object coerce(Object value) throws CoercionException;
     	/**
     	 * If the field value can be any possible value, for its type.
+    	 *
     	 * @deprecated now autodetect the mode of use
     	 */
     	static final int ANY = 1;
     	/**
     	 * If the field value must be one of a list of posible values.
+    	 *
     	 * @deprecated usado automaticamente al asignar AvailableValues
     	 */
         static final int CHOICE = 2;
     	/**
     	 * If the field value must pertain to a range of possible values.
+    	 *
     	 * @deprecated usado automaticamente al asignar minValue/maxValue
     	 */
         static final int RANGE = 3;
     	/**
     	 * @deprecated don't use, check minValue/maxValue and getAvailableValues instead
     	 */
     	int getTheTypeOfAvailableValues(); // SINGLE, CHOICE o RANGE
     	/**
     	 * @deprecated use instead {@link #setDefaultValue(Object)}
     	 */
     	DynField setDefaultDynValue(Object defaultValue);
     	/**
     	 * @deprecated don't use, set minValue/maxValue and availableValues instead
     	 */
     	DynField setTheTypeOfAvailableValues(int type);
+    }

Also available in: Unified diff

Application: gvSIG desktop » Library: org.gvsig.tools

Revision 212 org.gvsig.tools/library/trunk/org.gvsig.tools/org.gvsig.tools.lib/src/main/java/org/gvsig/tools/dynobject/DynField.java