org.nhindirect.policy.PolicyLexicon Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of direct-policy Show documentation
Direct Project policy enablement engine
There is a newer version: 8.0.0
/* 
Copyright (c) 2010, NHIN Direct Project
All rights reserved.

Authors:
   Greg Meyer      [email protected]
 
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer 
in the documentation and/or other materials provided with the distribution.  Neither the name of the The NHIN Direct Project (nhindirect.org). 
nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
THE POSSIBILITY OF SUCH DAMAGE.
*/

package org.nhindirect.policy;

import org.nhindirect.policy.impl.JavaSerializedObjectLexiconPolicyParser;
import org.nhindirect.policy.impl.SimpleTextV1LexiconPolicyParser;
import org.nhindirect.policy.impl.XMLLexiconPolicyParser;

/**
 * Lexicons are canonical formats of a {@link PolicyExpression} represented by a defined set of tokens and a grammar.  Expressions written in a given lexicon
 * are parsed by a {@link PolicyLexiconParser} and translated into {@link PolicyExpression}.  The {@link PolicyExpression} can be thought of an intermediate state
 * of the policy in the overall policy engine process.
 * 

 * This enumeration lists the supported lexicons by the policy engine.
 * @author Greg Meyer
 * @since 1.0
 */
public enum PolicyLexicon 
{
	/**
	 * XML Serialized format of a {@link PolicyExpression}.
	 */
	XML(XMLLexiconPolicyParser.class),
	
	
	/**
	 * Java serialized object format of a {@link PolicyExpression}.
	 */
	JAVA_SER(JavaSerializedObjectLexiconPolicyParser.class),
	
	/**
	 * Simple text version 1 lexicon
	 */
	SIMPLE_TEXT_V1(SimpleTextV1LexiconPolicyParser.class);
	
	protected final Class parserClass;
	
	/*
	 * Private constructor
	 */
	private PolicyLexicon(Class parserClass)
	{
		this.parserClass = parserClass;
	}
	
	/**
	 * Gets the {@link PolicyLexiconParser} class that will be used to parse the specific lexicon.
	 * @return The {@link PolicyLexiconParser} class that will be used to parse the specific lexicon.
	 */
	public Class getParserClass()
	{
		return parserClass;
	}
}