1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.filter;
35
36 import java.util.HashMap;
37 import java.util.Map;
38
39
40 /**
41 * Filter Entry used to load filter from the plugin XML file
42 */
43 public class FilterEntry
44 {
45 public static final int ORDER_NOT_DEFINED = -1;
46 private String _strName;
47 private String _strFilterClass;
48 private String _strMapping;
49 private Map<String, String> _mapInitParameters = new HashMap<String, String>( );
50 private int _nOrder = ORDER_NOT_DEFINED;
51
52 /**
53 * Returns the Name
54 *
55 * @return The Name
56 */
57 public String getName( )
58 {
59 return _strName;
60 }
61
62 /**
63 * Sets the Name
64 *
65 * @param strName The Name
66 */
67 public void setName( String strName )
68 {
69 _strName = strName;
70 }
71
72 /**
73 * Returns the filter
74 *
75 * @return The filter
76 */
77 public String getFilterClass( )
78 {
79 return _strFilterClass;
80 }
81
82 /**
83 * Sets the filter
84 *
85 * @param strFilterClass The filter
86 */
87 public void setFilterClass( String strFilterClass )
88 {
89 _strFilterClass = strFilterClass;
90 }
91
92 /**
93 * Returns the Mapping
94 *
95 * @return The Mapping
96 */
97 public String getMappingUrlPattern( )
98 {
99 return _strMapping;
100 }
101
102 /**
103 * Sets the Mapping
104 *
105 * @param strMapping The Mapping
106 */
107 public void setMappingUrlPattern( String strMapping )
108 {
109 _strMapping = strMapping;
110 }
111
112 /**
113 * Add an init parameter
114 * @param strName The parameter name
115 * @param strValue The parameter value
116 */
117 public void addParameter( String strName, String strValue )
118 {
119 _mapInitParameters.put( strName, strValue );
120 }
121
122 /**
123 * Returns init parameters
124 * @return Init parameters in a map object
125 */
126 public Map<String, String> getInitParameters( )
127 {
128 return _mapInitParameters;
129 }
130
131 /**
132 *
133 * Returns the order.
134 * {@link #getOrder()} == {@value #ORDER_NOT_DEFINED} means there is no priority set for the filter
135 * @return the order
136 */
137 public int getOrder( )
138 {
139 return _nOrder;
140 }
141
142 /**
143 * nOrder == == {@value #ORDER_NOT_DEFINED} means there is no priority set for the filter
144 * @param nOrder the order
145 */
146 public void setOrder( int nOrder )
147 {
148 _nOrder = nOrder;
149 }
150 }