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.regularexpression;
35
36 import fr.paris.lutece.portal.business.regularexpression.RegularExpression;
37
38 import java.util.List;
39
40
41 /**
42 *
43 * IRegularExpressionService
44 */
45 public interface IRegularExpressionService
46 {
47 /**
48 * return false if the pattern is invalid
49 * @param strPattern the pattern to test
50 * @return false if the pattern is invalid
51 */
52 boolean isPatternValide( String strPattern );
53
54 /**
55 * return false if the expression's syntax is invalid
56 * @param regularExpression the regular expression object to test
57 * @return false if the expression's syntax is invalid
58 */
59 boolean isPatternValide( RegularExpression regularExpression );
60
61 /**
62 * return true if the value in parameter verify the pattern
63 * @param strValueToTest the value to test
64 * @param strPattern the regular expression Pattern
65 * @return true if the value in parameter verify the pattern
66 */
67 boolean isMatches( String strValueToTest, String strPattern );
68
69 /**
70 * return true if the value in parameter verify the regular expression
71 * @param strValueToTest the value to test
72 * @param regularExpression the regular expression
73 * @return true if the value verify the regular expression
74 */
75 boolean isMatches( String strValueToTest, RegularExpression regularExpression );
76
77 /**
78 * return the regular expression object whose identifier is specified in parameter
79 * @param nKey the regular expression key
80 * @return the regular expression object whose identifier is specified in parameter
81 */
82 RegularExpression getRegularExpressionByKey( int nKey );
83
84 /**
85 * return a list of regular expression
86 * @return all regular expression
87 */
88 List<RegularExpression> getAllRegularExpression( );
89 }