src/skrueger/AttributeMetadataInterface.java

package skrueger;

import java.util.HashSet;

import org.geotools.feature.NameImpl;
import org.opengis.feature.type.Name;

import skrueger.geotools.Copyable;
import skrueger.i8n.Translation;

public interface AttributeMetadataInterface extends Copyable<AttributeMetadataInterface>,
                Comparable<AttributeMetadataInterface> {

        /**
         * @return a translatable title for this attribute..
         */
        public Translation getTitle();

        /**
         * Set a translatable title for this attribute..
         */
        public void setTitle(Translation title);
        
        /**
         * Set an untranslated title for this attribute or pass a {@link Translation} encryped as a {@link String}
         */
        public void setTitle(String title);

        /**
         * @return a translatable description for this attribute
         */
        public Translation getDesc();

        /**
         * Set a translatable description for this attribute.
         */
        public void setDesc(Translation desc);

        /**
         * Set an untranslated description for this attribute or pass a {@link Translation} encryped as a {@link String}  
         */
        public void setDesc(String desc);


        /**
         * The local name. E.g. the name of the DBF column as a {@link String}.
         */
        public String getLocalName();

        /**
         * A short form for #setName(new NameImpl(localName))
         */
        public void setLocalName(String localName);

        /**
         * The fully qualified {@link Name} of the attribute, e.g.
         * <code>org.bla.plo:blub</code>. The second part equals the
         * {@link #getLocalName()} value. The first may be <code>null</code> or
         * represent the layer name.
         */
        public Name getName();

        /**
         * set the fully qualified {@link Name} of this attribute.
         */
        public void setName(Name name);

        /**
         * A list og objects that represent NODATA-values for this attribute. The
         * objects are supporsed to be correctly casted already. That means that the
         * NODATA objects listed here have must have the same type as the values of
         * this object.
         */
        public HashSet<Object> getNodataValues();

        /**
         * Takes any value object and checks it against the NODATA values. If the
         * value equals a NODATA value, <code>null</code> is returned. Otherwise the
         * same object is returned.
         * 
         * Note: This method is called often.
         */
        public Object fiterNodata(Object value);

        /**
         * @return a non-translatable unit {@link String} for this attribute values.
         */
        public String getUnit();

        /**
         * Set a unit {@link String} for this attribute values.
         */
        public void setUnit(String unit);

        /**
         * @return A value defining the position of this attribute whenever the
         *         attributes are listed to an end-user. The higher the weight, the
         *         lower the position. (heavy goes down, light goes up)
         */
        public double getWeight();

        /**
         * set a value defining the position of this attribute whenever the
         * attributes are listed to an end-user. The higher the weight, the lower
         * the position. (heavy goes down, light goes up)
         */
        public void setWeight(double weight);

        /**
         * @return <code>false</code> if this attribute should not be selectable or
         *         shown to the end-user.
         */
        public boolean isVisible();

        /**
         * Set <code>false</code> if this attribute should not be shown to the
         * end-user.
         */
        public void setVisible(boolean visible);

        String getNoDataValuesFormatted();

}
1	package skrueger;
2
3	import java.util.HashSet;
4
5	import org.geotools.feature.NameImpl;
6	import org.opengis.feature.type.Name;
7
8	import skrueger.geotools.Copyable;
9	import skrueger.i8n.Translation;
10
11	public interface AttributeMetadataInterface extends Copyable<AttributeMetadataInterface>,
12	Comparable<AttributeMetadataInterface> {
13
14	/**
15	* @return a translatable title for this attribute..
16	*/
17	public Translation getTitle();
18
19	/**
20	* Set a translatable title for this attribute..
21	*/
22	public void setTitle(Translation title);
23
24	/**
25	* Set an untranslated title for this attribute or pass a {@link Translation} encryped as a {@link String}
26	*/
27	public void setTitle(String title);
28
29	/**
30	* @return a translatable description for this attribute
31	*/
32	public Translation getDesc();
33
34	/**
35	* Set a translatable description for this attribute.
36	*/
37	public void setDesc(Translation desc);
38
39	/**
40	* Set an untranslated description for this attribute or pass a {@link Translation} encryped as a {@link String}
41	*/
42	public void setDesc(String desc);
43
44
45	/**
46	* The local name. E.g. the name of the DBF column as a {@link String}.
47	*/
48	public String getLocalName();
49
50	/**
51	* A short form for #setName(new NameImpl(localName))
52	*/
53	public void setLocalName(String localName);
54
55	/**
56	* The fully qualified {@link Name} of the attribute, e.g.
57	* <code>org.bla.plo:blub</code>. The second part equals the
58	* {@link #getLocalName()} value. The first may be <code>null</code> or
59	* represent the layer name.
60	*/
61	public Name getName();
62
63	/**
64	* set the fully qualified {@link Name} of this attribute.
65	*/
66	public void setName(Name name);
67
68	/**
69	* A list og objects that represent NODATA-values for this attribute. The
70	* objects are supporsed to be correctly casted already. That means that the
71	* NODATA objects listed here have must have the same type as the values of
72	* this object.
73	*/
74	public HashSet<Object> getNodataValues();
75
76	/**
77	* Takes any value object and checks it against the NODATA values. If the
78	* value equals a NODATA value, <code>null</code> is returned. Otherwise the
79	* same object is returned.
80	*
81	* Note: This method is called often.
82	*/
83	public Object fiterNodata(Object value);
84
85	/**
86	* @return a non-translatable unit {@link String} for this attribute values.
87	*/
88	public String getUnit();
89
90	/**
91	* Set a unit {@link String} for this attribute values.
92	*/
93	public void setUnit(String unit);
94
95	/**
96	* @return A value defining the position of this attribute whenever the
97	* attributes are listed to an end-user. The higher the weight, the
98	* lower the position. (heavy goes down, light goes up)
99	*/
100	public double getWeight();
101
102	/**
103	* set a value defining the position of this attribute whenever the
104	* attributes are listed to an end-user. The higher the weight, the lower
105	* the position. (heavy goes down, light goes up)
106	*/
107	public void setWeight(double weight);
108
109	/**
110	* @return <code>false</code> if this attribute should not be selectable or
111	* shown to the end-user.
112	*/
113	public boolean isVisible();
114
115	/**
116	* Set <code>false</code> if this attribute should not be shown to the
117	* end-user.
118	*/
119	public void setVisible(boolean visible);
120
121	String getNoDataValuesFormatted();
122
123	}