View Javadoc

1   package ar.com.epere4.java2excel.parser;
2   
3   import ognl.OgnlException;
4   
5   /***
6    * This interface represents an instance of the 
7    * property tag in the configuration xml file.
8    * 
9    * Properties defined in this interface are documented in the dtd schema that
10   * you can find in the url defined by
11   * {@link ar.com.epere4.java2excel.parser.Parser#JAVA2EXCEL_SYSTEM_ID} or in the
12   * resource you can find in
13   * {@link ar.com.epere4.java2excel.parser.Parser#JAVA2EXCEL_LOCAL_DTD_URL}.
14   * 
15   * @author epere4
16   * 
17   */
18  public interface PropertyDtd {
19  
20      /***
21       * @return Returns the name.
22       */
23      String getExpression();
24      
25      /***
26       * @return the property title.
27       * @since 18/02/2006
28       */
29      String getTitle();
30  
31      /***
32       * @return Returns the description.
33       */
34      String getDescription();
35  
36      /***
37       * @return true if null pointer protection is active.
38       * @since 18/02/2006
39       */
40      boolean isProtectNullPointer();
41      
42      /***
43       * Evaluates the {@link #getExpression() ognl expression} 
44       * against the suplied element.
45       * @param element the element which is going to be target for the
46       * ognl expression.
47       * @return the result of the evaluation
48       * @throws OgnlException if the is an exception while evaluating ognl.
49       * @since 09/03/2006
50       */
51      Object evaluateExpression(Object element) throws OgnlException;
52  }