root / branches / v2_0_0_prep / libraries / libFMap_dal / src / org / gvsig / fmap / dal / DataParameterDescriptor.java @ 24496
History | View | Annotate | Download (1.82 KB)
| 1 | 24496 | jmvivo | package org.gvsig.fmap.dal; |
|---|---|---|---|
| 2 | 23894 | jjdelcerro | |
| 3 | 24391 | jiyarza | /**
|
| 4 | * This interface describes the properties of a parameter. It is useful
|
||
| 5 | * for any component that needs to know how to edit or visualize it.
|
||
| 6 | *
|
||
| 7 | */
|
||
| 8 | 24250 | jjdelcerro | public interface DataParameterDescriptor { |
| 9 | 24391 | jiyarza | |
| 10 | /** Accepts a single value */
|
||
| 11 | 23894 | jjdelcerro | public static final int SINGLE = 1; |
| 12 | 24391 | jiyarza | /** Accepts a single value from a value set */
|
| 13 | 23894 | jjdelcerro | public static final int CHOICE = 2; |
| 14 | 24391 | jiyarza | /** Accepts a range of values defined with a minimum and a maximum value */
|
| 15 | 23894 | jjdelcerro | public static final int RANGE = 3; |
| 16 | |||
| 17 | 24391 | jiyarza | /**
|
| 18 | * Returns the parameter's name
|
||
| 19 | *
|
||
| 20 | * @return String containing the parameter's name
|
||
| 21 | */
|
||
| 22 | 23894 | jjdelcerro | public String getName(); |
| 23 | 24391 | jiyarza | |
| 24 | /**
|
||
| 25 | * Returns the parameter's description
|
||
| 26 | *
|
||
| 27 | * @return String containing the parameter's description.
|
||
| 28 | */
|
||
| 29 | 23894 | jjdelcerro | public String getDescription(); |
| 30 | |||
| 31 | 24391 | jiyarza | /**
|
| 32 | * Returns the parameter's data type.
|
||
| 33 | *
|
||
| 34 | * @return parameter's data type.
|
||
| 35 | * @see #DataTypes
|
||
| 36 | */
|
||
| 37 | 23894 | jjdelcerro | public int getDataType(); |
| 38 | |||
| 39 | 24391 | jiyarza | /**
|
| 40 | * Returns the parameter's default value.
|
||
| 41 | *
|
||
| 42 | * @return an Object containing the default value. Use the data type to cast.
|
||
| 43 | */
|
||
| 44 | 23894 | jjdelcerro | public Object getDefaultValue(); |
| 45 | 24391 | jiyarza | |
| 46 | /**
|
||
| 47 | * Returns one of the available values type.
|
||
| 48 | *
|
||
| 49 | * @return an <code>int</code> with one of the available values type.
|
||
| 50 | *
|
||
| 51 | * @see #SINGLE
|
||
| 52 | * @see #CHOICE
|
||
| 53 | * @see #RANGE
|
||
| 54 | */
|
||
| 55 | 23894 | jjdelcerro | public int getAvailableValuesType(); |
| 56 | |||
| 57 | 24391 | jiyarza | /**
|
| 58 | * Returns an array containing the available values accepted by the parameter.
|
||
| 59 | *
|
||
| 60 | * @return array of Object containing the available values accepted by the parameter. Use the data type to cast.
|
||
| 61 | */
|
||
| 62 | 23894 | jjdelcerro | public Object[] getAvailableValues(); |
| 63 | |||
| 64 | 24391 | jiyarza | /**
|
| 65 | * Returns the minimum value when the parameter accepts a range of values.
|
||
| 66 | *
|
||
| 67 | * @return range's minimum value
|
||
| 68 | */
|
||
| 69 | 23894 | jjdelcerro | public Object getMinValue(); |
| 70 | |||
| 71 | 24391 | jiyarza | /**
|
| 72 | * Returns the maximum value when the parameter accepts a range of values.
|
||
| 73 | *
|
||
| 74 | * @return range's maximum value.
|
||
| 75 | */
|
||
| 76 | 23894 | jjdelcerro | public Object getMaxValue(); |
| 77 | } |