KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jahia > clipbuilder > html > web > html > ExtractorFilter


1 package org.jahia.clipbuilder.html.web.html;
2
3 import java.util.Map JavaDoc;
4
5 /**
6  * Object that aims at finding the selected part of an html document
7  *
8  *@author Tlili Khaled
9  */
10 public interface ExtractorFilter {
11     /**
12      * Description of the Field
13      */
14     public static final int MODE_CSS = 0;
15     /**
16      * Description of the Field
17      */
18     public static final int MODE_WHITOUT_CSS = 1;
19         public static final int ACTION_BUILD_KEY_PART = 0;
20         public static final int ACTION_RETRIEVE_SELECTED_PART = 1;
21
22
23     /**
24      * Gets the SelectedPart attribute of the ExtractorFilter object
25      *
26      *@param doc Description of Parameter
27      *@return The SelectedPart value
28      *@exception Exception Description of Exception
29      */
30     abstract String JavaDoc getSelectedPart(HTMLDocument doc,int action) throws Exception JavaDoc;
31
32
33     /**
34      * Gets the KeyMap attribute of the ExtractorFilter object
35      *
36      *@return The KeyMap value
37      */
38     abstract Map JavaDoc getKeyMap();
39
40
41     /**
42      * Sets the KeyMap attribute of the ExtractorFilter object
43      *
44      *@param map The new KeyMap value
45      */
46     abstract void setKeyMap(Map JavaDoc map);
47
48
49     /**
50      * Gets the KeyPart attribute of the ExtractorFilter object
51      *
52      *@param name Description of Parameter
53      *@return The KeyPart value
54      */
55     abstract String JavaDoc getKeyPart(String JavaDoc name);
56
57
58     /**
59      * Adds a feature to the KeyPart attribute of the ExtractorFilter object
60      *
61      *@param name The feature to be added to the KeyPart attribute
62      *@param value The feature to be added to the KeyPart attribute
63      */
64     abstract void addKeyPart(String JavaDoc name, String JavaDoc value);
65
66
67     /**
68      * Gets the Name attribute of the ExtractorFilter object
69      *
70      *@return The Name value
71      */
72     abstract String JavaDoc getName();
73
74
75     /**
76      * Sets the Name attribute of the ExtractorFilter object
77      *
78      *@param name The new Name value
79      */
80     abstract void setName(String JavaDoc name);
81
82
83     /**
84      * Gets the Mode attribute of the ExtractorFilter object
85      *
86      *@return The Mode value
87      */
88     abstract int getMode();
89
90
91     /**
92      * Sets the Mode attribute of the ExtractorFilter object
93      *
94      *@param mode The new Mode value
95      */
96     abstract void setMode(int mode);
97 }
98
Popular Tags