org.anadix.Parser Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011 Tomas Schlosser
 *
 * Licensed 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.
 */
package org.anadix;

import java.util.Collection;

import org.anadix.exceptions.ParserException;
import org.anadix.utils.DroolsResource;

/**
 * Class used to parse the source.
 * The class has a few purposes:
 * 
 *   defines used fact model by parser - by returning class of
 *   		ElementFactory by method getElementFactoryClass()
 *   defines Drools resources - by returning collection of them by
 *   		method getDroolsResources
 *   actualy parses given sources - by implementing method
 *   		parse
 * where
 *
 * @author tomason
 * @version $Id: $
 */
public interface Parser {

    /**
     * Parses given source and inserts Elements through ElementFactory
     *
     * @param factory - ElementFactory to be used
     * @param source - source to parse
     * @throws org.anadix.exceptions.ParserException - when something goes wrong during parsing
     */
    void parse(ElementFactory factory, Source source) throws ParserException;

    /**
     * Returns resources (typically DRL files) used by Drools engine
     * to process parser output. If no such resources are used this method
     * returns empty collection
     *
     * @return collection of DroolsResources
     */
    Collection getDroolsResources();

    /**
     * Returns class implementing ElementFactory that is used to insert
     * elements into Drools working memory
     *
     * @return instance of Class
     */
    Class getElementFactoryClass();
}