de.aristaflow.adept2.core.orgmodelmanager.parser

Class OrgPolicyParser

java.lang.Object

de.aristaflow.adept2.core.orgmodelmanager.parser.OrgPolicyParser

public abstract class OrgPolicyParser
extends java.lang.Object

The OrgModelManager provides facilities to syntactically parse and verify OrgPolicies and return them as an easy to use object structure.

Constructor Summary

Constructors

Constructor and Description
OrgPolicyParser()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	format(EntityExpression entityExpression) Takes the given EntityExpression and formats it back to an OrgPolicy string.
static OrgPolicyParser	getInstance(java.util.logging.Logger logger) Returns an OrgPolicyParser using the designated logger.
abstract EntityExpression	parse(java.lang.String orgPolicy, OrgPolicyReport report, boolean reportOnly, boolean binaryReport, boolean rejectParameterReferences, TokenInfoContainer tokenInfos) This method will parse the given OrgPolicy.
abstract EntityExpression	parse(java.lang.String orgPolicy, OrgPolicyReport report, TokenInfoContainer tokenInfos) This method will parse the given OrgPolicy and return it as an object structure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrgPolicyParser

public OrgPolicyParser()

Method Detail

parse

public abstract EntityExpression parse(java.lang.String orgPolicy,
                                       OrgPolicyReport report,
                                       TokenInfoContainer tokenInfos)

This method will parse the given OrgPolicy and return it as an object structure. Unless there were any errors in the policy in which case null is returned.

Use report.getCheckResult() != ResultType.ERROR to check whether the parsing was successful.

This parse method will...

• any general syntax problems
• verify entity types
• verify functions (including source/target entity types and transitivity)
• verify attribute names (but NOT whether they actually exist)
• verify operators (including whether it can be applied on the value literal)
• verify the type of value literals

Parameters:

orgPolicy - the OrgPolicy to be parsed

report - a report that will be filled with an entry for each encountered problem; null is not allowed!

tokenInfos - an optional container where TokenInfos will be filled in

Returns:

an object structure created from the OrgPolicy string or null if there were any errors

parse

public abstract EntityExpression parse(java.lang.String orgPolicy,
                                       OrgPolicyReport report,
                                       boolean reportOnly,
                                       boolean binaryReport,
                                       boolean rejectParameterReferences,
                                       TokenInfoContainer tokenInfos)

This method will parse the given OrgPolicy. Unless reportOnly is true it will return the policy as an object structure. It will return null if reportOnly is true or there were any errors in the policy.

If no detailed report is required, set binaryReport to true. In case of failure the report will only contain one entry.

In any case, use report.getCheckResult() != ResultType.ERROR to check whether the parsing was successful.

This parse method will...

• any general syntax problems
• verify entity types
• verify functions (including source/target entity types and transitivity)
• verify attribute names (but NOT whether they actually exist)
• verify operators (including whether it can be applied on the value literal)
• verify the type of value literals

Parameters:

orgPolicy - the OrgPolicy to be parsed

report - a report that will be filled with an entry for each encountered problem; null is not allowed!

reportOnly - whether only the report (and no object structure) is required

binaryReport - whether the report should only indicate success or failure and not contain any more details

rejectParameterReferences - whether parameter references in the org policy should be rejected, i.e. treated as an error (see SystemDataConsumer)

tokenInfos - an optional container where TokenInfos will be filled in

Returns:

an object structure created from the OrgPolicy string or null if there were any errors or reportOnly is true

format

public abstract java.lang.String format(EntityExpression entityExpression)

Takes the given EntityExpression and formats it back to an OrgPolicy string.

Parameters:

entityExpression - the EntityExpression to be returned as OrgPolicy string

Returns:

the EntityExpression as OrgPolicy string

getInstance

public static OrgPolicyParser getInstance(java.util.logging.Logger logger)

Returns an OrgPolicyParser using the designated logger.

Returns:

An OrgPolicyParser using the designated logger.