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 */
020package org.apache.directory.api.ldap.model.schema.parsers;
021
022
023import java.text.ParseException;
024
025import org.apache.directory.api.i18n.I18n;
026import org.apache.directory.api.ldap.model.schema.MatchingRuleUse;
027
028
029/**
030 * A parser for RFC 4512 matching rule use descriptions.
031 * 
032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033 */
034public class MatchingRuleUseDescriptionSchemaParser extends AbstractSchemaParser<MatchingRuleUse>
035{
036
037    /**
038     * Creates a schema parser instance.
039     */
040    public MatchingRuleUseDescriptionSchemaParser()
041    {
042        super( MatchingRuleUse.class, I18n.ERR_13848_CANNOT_PARSE_NULL_MRU, I18n.ERR_13849_MRU_PARSING_FAILURE, 
043            I18n.ERR_13850_MRU_DESC_PARSING_FAILURE );
044    }
045
046
047    /**
048     * Parses a matching rule use description according to RFC 4512:
049     * 
050     * <pre>
051     * MatchingRuleUseDescription = LPAREN WSP
052     *    numericoid                 ; object identifier
053     *    [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
054     *    [ SP "DESC" SP qdstring ]  ; description
055     *    [ SP "OBSOLETE" ]          ; not active
056     *    SP "APPLIES" SP oids       ; attribute types
057     *    extensions WSP RPAREN      ; extensions
058     * 
059     * extensions = *( SP xstring SP qdstrings )
060     * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 
061     * </pre>
062     * 
063     * @param matchingRuleUseDescription the matching rule use description to be parsed
064     * @return the parsed MatchingRuleUseDescription bean
065     * @throws ParseException if there are any recognition errors (bad syntax)
066     */
067    public MatchingRuleUse parse( String matchingRuleUseDescription ) throws ParseException
068    {
069        MatchingRuleUse matchingRuleUse = fastParser.parseMatchingRuleUse( matchingRuleUseDescription );
070        matchingRuleUse.setSpecification( matchingRuleUseDescription );
071
072        // Update the schemaName
073        updateSchemaName( matchingRuleUse );
074
075        return matchingRuleUse;
076    }
077}