001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements. See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership. The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License. You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied. See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 *
019 */
020 package org.apache.directory.shared.ldap.schema.parsers;
021
022
023 import java.text.ParseException;
024
025
026 import antlr.RecognitionException;
027 import antlr.TokenStreamException;
028
029
030 /**
031 * A parser for RFC 4512 DIT structure rule descriptons
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 * @version $Rev$, $Date$
035 */
036 public class DITStructureRuleDescriptionSchemaParser extends AbstractSchemaParser
037 {
038
039 /**
040 * Creates a schema parser instance.
041 */
042 public DITStructureRuleDescriptionSchemaParser()
043 {
044 }
045
046
047 /**
048 * Parses a DIT structure rule description according to RFC 4512:
049 *
050 * <pre>
051 * DITStructureRuleDescription = LPAREN WSP
052 * ruleid ; rule identifier
053 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
054 * [ SP "DESC" SP qdstring ] ; description
055 * [ SP "OBSOLETE" ] ; not active
056 * SP "FORM" SP oid ; NameForm
057 * [ SP "SUP" ruleids ] ; superior rules
058 * extensions WSP RPAREN ; extensions
059 *
060 * ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN )
061 * ruleidlist = ruleid *( SP ruleid )
062 * ruleid = numbers
063 * </pre>
064 *
065 * @param ditStructureRuleDescription the DIT structure rule description to be parsed
066 * @return the parsed DITStructureRuleDescription bean
067 * @throws ParseException if there are any recognition errors (bad syntax)
068 */
069 public synchronized DITStructureRuleDescription parseDITStructureRuleDescription( String ditStructureRuleDescription )
070 throws ParseException
071 {
072
073 if ( ditStructureRuleDescription == null )
074 {
075 throw new ParseException( "Null", 0 );
076 }
077
078 reset( ditStructureRuleDescription ); // reset and initialize the parser / lexer pair
079
080 try
081 {
082 DITStructureRuleDescription dsrd = parser.ditStructureRuleDescription();
083 return dsrd;
084 }
085 catch ( RecognitionException re )
086 {
087 String msg = "Parser failure on DIT structure rule description:\n\t" + ditStructureRuleDescription;
088 msg += "\nAntlr message: " + re.getMessage();
089 msg += "\nAntlr column: " + re.getColumn();
090 throw new ParseException( msg, re.getColumn() );
091 }
092 catch ( TokenStreamException tse )
093 {
094 String msg = "Parser failure on DIT structure rule description:\n\t" + ditStructureRuleDescription;
095 msg += "\nAntlr message: " + tse.getMessage();
096 throw new ParseException( msg, 0 );
097 }
098
099 }
100
101
102 public AbstractSchemaDescription parse( String schemaDescription ) throws ParseException
103 {
104 return parseDITStructureRuleDescription( schemaDescription );
105 }
106
107 }