View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.ldap.model.schema.parsers;
21  
22  
23  import java.text.ParseException;
24  
25  import org.apache.directory.api.i18n.I18n;
26  import org.apache.directory.api.ldap.model.schema.MatchingRule;
27  
28  import antlr.RecognitionException;
29  import antlr.TokenStreamException;
30  
31  
32  /**
33   * A parser for RFC 4512 matching rule descriptions.
34   * 
35   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
36   */
37  public class MatchingRuleDescriptionSchemaParser extends AbstractSchemaParser<MatchingRule>
38  {
39      /**
40       * Creates a schema parser instance.
41       */
42      public MatchingRuleDescriptionSchemaParser()
43      {
44          super( MatchingRule.class, I18n.ERR_04242, I18n.ERR_04243, I18n.ERR_04244 );
45      }
46  
47  
48      /**
49       * Parses a matching rule description according to RFC 4512:
50       * 
51       * <pre>
52       * MatchingRuleDescription = LPAREN WSP
53       *    numericoid                 ; object identifier
54       *    [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
55       *    [ SP "DESC" SP qdstring ]  ; description
56       *    [ SP "OBSOLETE" ]          ; not active
57       *    SP "SYNTAX" SP numericoid  ; assertion syntax
58       *    extensions WSP RPAREN      ; extensions
59       * 
60       * extensions = *( SP xstring SP qdstrings )
61       * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 
62       * </pre>
63       * 
64       * @param matchingRuleDescription the matching rule description to be parsed
65       * @return the parsed MatchingRuleDescription bean
66       * @throws ParseException if there are any recognition errors (bad syntax)
67       */
68      public MatchingRule parseMatchingRuleDescription( String matchingRuleDescription ) throws ParseException
69      {
70          return super.parse( matchingRuleDescription );
71      }
72  
73  
74      /**
75       * {@inheritDoc}
76       */
77      @Override
78      protected MatchingRule doParse() throws RecognitionException, TokenStreamException
79      {
80          return parser.matchingRuleDescription();
81      }
82  
83  }