pops.ale.epc.spec
Class ECFilterListMember

java.lang.Object
  extended by pops.ale.epc.spec.Spec
      extended by pops.ale.epc.spec.ECFilterListMember

public class ECFilterListMember
extends Spec

An ECFilterListMember specifies filtering by comparing a single field of a Tag to a set of patterns. This type is used in both the Reading API and the Writing API.

Each ECFilterListMember specifies either an inclusive or an exclusive test based on the value of one field of a Tag. If the includeExclude parameter of an ECFilterListMember is INCLUDE, then the Tag passes the test if and only if accessing the field does not cause a "field not found" or "operation not possible" condition and the value of the field matches at least one pattern specified in the ECFilterListMember instance. If the includeExclude parameter of an ECFilterListMember is EXCLUDE, then the Tag passes the test if and only if accessing the field causes a "field not found" or "operation not possible" condition or the value of the field does not match any pattern specified in the ECFilterListMember instance.

This can be expressed using the following notation, where R is the set of Tags to be reported from a given event cycle, prior to filtering:

Where Ii,j denotes the set of Tags matched by the jth pattern in the patList of the ith member of filterList whose includeExclude flag is set to INCLUDE, and Ei, j denotes the set of Tags matched by the jth pattern in the patList of the ith member of filterList whose includeExclude flag is set to EXCLUDE.

Author:
pops, R.DAGHER

Constructor Summary
ECFilterListMember(java.util.Properties spec_property)
          Constructor from a Java property file
 
Method Summary
 ECFieldSpec getFieldspec()
          Getter for fieldspec
 java.lang.String[] getPatList()
          Getter for patList
 boolean isIncludeExclude()
          Getter for includeExclude
 void loadFromProp(java.util.Properties spec_property)
          Set up fields from a Java property object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ECFilterListMember

public ECFilterListMember(java.util.Properties spec_property)
Constructor from a Java property file

Parameters:
spec_property - Java property object containing specification data
Method Detail

loadFromProp

public void loadFromProp(java.util.Properties spec_property)
Set up fields from a Java property object

Specified by:
loadFromProp in class Spec
Parameters:
spec_property - Java property object containing specification data

isIncludeExclude

public boolean isIncludeExclude()
Getter for includeExclude

Returns:
the includeExclude

getFieldspec

public ECFieldSpec getFieldspec()
Getter for fieldspec

Returns:
the fieldspec

getPatList

public java.lang.String[] getPatList()
Getter for patList

Returns:
the patList