package org.apache.commons.digester3;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.ArrayList;
import java.util.List;

import org.xml.sax.Attributes;


Rules implementation that uses regular expression matching for paths.


The regex implementation is pluggable, allowing different strategies to be used. The basic way that this class work
does not vary. All patterns are tested to see if they match the path using the regex matcher. All those that do are
return in the order which the rules were added.

Since:
1.5/**
 * <p>
 * Rules implementation that uses regular expression matching for paths.
 * </p>
 * <p>
 * The regex implementation is pluggable, allowing different strategies to be used. The basic way that this class work
 * does not vary. All patterns are tested to see if they match the path using the regex matcher. All those that do are
 * return in the order which the rules were added.
 * </p>
 * 
 * @since 1.5
 */
public class RegexRules
    extends AbstractRulesImpl
{

    // --------------------------------------------------------- Fields

    
All registered Rule's /** All registered <code>Rule</code>'s */
    private ArrayList<RegisteredRule> registeredRules = new ArrayList<RegisteredRule>();

    
The regex strategy used by this RegexRules /** The regex strategy used by this RegexRules */
    private RegexMatcher matcher;

    // --------------------------------------------------------- Constructor

    
Construct sets the Regex matching strategy.
Params:
matcher – the regex strategy to be used, not null/**
     * Construct sets the Regex matching strategy.
     * 
     * @param matcher the regex strategy to be used, not null
     */
    public RegexRules( RegexMatcher matcher )
    {
        setRegexMatcher( matcher );
    }

    // --------------------------------------------------------- Properties

    
Gets the current regex matching strategy.
Returns:
the current regex matching strategy./**
     * Gets the current regex matching strategy.
     *
     * @return the current regex matching strategy.
     */
    public RegexMatcher getRegexMatcher()
    {
        return matcher;
    }

    
Sets the current regex matching strategy.
Params:
matcher – use this RegexMatcher, not null/**
     * Sets the current regex matching strategy.
     * 
     * @param matcher use this RegexMatcher, not null
     */
    public void setRegexMatcher( RegexMatcher matcher )
    {
        if ( matcher == null )
        {
            throw new IllegalArgumentException( "RegexMatcher must not be null." );
        }
        this.matcher = matcher;
    }

    // --------------------------------------------------------- Public Methods

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    protected void registerRule( String pattern, Rule rule )
    {
        registeredRules.add( new RegisteredRule( pattern, rule ) );
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public void clear()
    {
        registeredRules.clear();
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public List<Rule> match( String namespaceURI, String pattern, String name, Attributes attributes )
    {
        //
        // not a particularly quick implementation
        // regex is probably going to be slower than string equality
        // so probably should have a set of strings
        // and test each only once
        //
        // XXX FIX ME - Time And Optimize
        //
        ArrayList<Rule> rules = new ArrayList<Rule>( registeredRules.size() );
        for ( RegisteredRule rr : registeredRules )
        {
            if ( matcher.match( pattern, rr.pattern ) )
            {
                rules.add( rr.rule );
            }
        }
        return rules;
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public List<Rule> rules()
    {
        ArrayList<Rule> rules = new ArrayList<Rule>( registeredRules.size() );
        for ( RegisteredRule rr : registeredRules )
        {
            rules.add( rr.rule );
        }
        return rules;
    }

    
Used to associate rules with paths in the rules list /** Used to associate rules with paths in the rules list */
    private static class RegisteredRule
    {
        String pattern;

        Rule rule;

        RegisteredRule( String pattern, Rule rule )
        {
            this.pattern = pattern;
            this.rule = rule;
        }
    }

}