java.lang.Object
- org.opennms.netmgt.correlation.drools.config.RuleSet

All Implemented Interfaces:

Serializable
```
public class RuleSet
extends Object
implements Serializable
```
Class RuleSet.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

RuleSet()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addEvent(int index, String vEvent)`
`void`	`addEvent(String vEvent)`
`void`	`addGlobal(int index, Global vGlobal)`
`void`	`addGlobal(Global vGlobal)`
`void`	`addRuleFile(int index, String vRuleFile)`
`void`	`addRuleFile(String vRuleFile)`
`CorrelationEngine`	`constructEngine(org.springframework.core.io.Resource basePath, org.springframework.context.ApplicationContext appContext, EventIpcManager eventIpcManager, com.codahale.metrics.MetricRegistry metricRegistry)`
`Enumeration<String>`	`enumerateEvent()`	Method enumerateEvent.
`Enumeration<Global>`	`enumerateGlobal()`	Method enumerateGlobal.
`Enumeration<String>`	`enumerateRuleFile()`	Method enumerateRuleFile.
`boolean`	`equals(Object obj)`
`String`	`getAppContext()`	Returns the value of field 'appContext'.
`String`	`getAssertBehaviour()`
`String`	`getConfigLocation()`
`String[]`	`getEvent()`	Method getEvent.Returns the contents of the collection in an Array.
`String`	`getEvent(int index)`	Method getEvent.
`List<String>`	`getEventCollection()`	Method getEventCollection.Returns a reference to '_eventList'.
`int`	`getEventCount()`	Method getEventCount.
`String`	`getEventProcessingMode()`
`Global[]`	`getGlobal()`	Method getGlobal.Returns the contents of the collection in an Array.
`Global`	`getGlobal(int index)`	Method getGlobal.
`List<Global>`	`getGlobalCollection()`	Method getGlobalCollection.Returns a reference to '_globalList'.
`int`	`getGlobalCount()`	Method getGlobalCount.
`Map<String,Object>`	`getGlobals(org.springframework.context.ApplicationContext context)`
`List<String>`	`getInterestingEvents()`
`String`	`getName()`	Returns the value of field 'name'.
`Boolean`	`getPersistState()`
`org.springframework.core.io.Resource`	`getResource(org.springframework.core.io.ResourceLoader resourceLoader, String resourcePath)`
`String[]`	`getRuleFile()`	Method getRuleFile.Returns the contents of the collection in an Array.
`String`	`getRuleFile(int index)`	Method getRuleFile.
`List<String>`	`getRuleFileCollection()`	Method getRuleFileCollection.Returns a reference to '_ruleFileList'.
`int`	`getRuleFileCount()`	Method getRuleFileCount.
`List<org.springframework.core.io.Resource>`	`getRuleResources(org.springframework.core.io.ResourceLoader resourceLoader)`
`int`	`hashCode()`
`Iterator<String>`	`iterateEvent()`	Method iterateEvent.
`Iterator<Global>`	`iterateGlobal()`	Method iterateGlobal.
`Iterator<String>`	`iterateRuleFile()`	Method iterateRuleFile.
`void`	`removeAllEvent()`
`void`	`removeAllGlobal()`
`void`	`removeAllRuleFile()`
`boolean`	`removeEvent(String vEvent)`	Method removeEvent.
`String`	`removeEventAt(int index)`	Method removeEventAt.
`boolean`	`removeGlobal(Global vGlobal)`	Method removeGlobal.
`Global`	`removeGlobalAt(int index)`	Method removeGlobalAt.
`boolean`	`removeRuleFile(String vRuleFile)`	Method removeRuleFile.
`String`	`removeRuleFileAt(int index)`	Method removeRuleFileAt.
`void`	`setAppContext(String appContext)`	Sets the value of field 'appContext'.
`void`	`setAssertBehaviour(String assertBehaviour)`
`void`	`setEvent(int index, String vEvent)`
`void`	`setEvent(String[] vEventArray)`
`void`	`setEvent(List<String> vEventList)`	Sets the value of '_eventList' by copying the given Vector.
`void`	`setEventCollection(List<String> eventList)`	Deprecated.
`void`	`setEventProcessingMode(String eventProcessingMode)`
`void`	`setGlobal(int index, Global vGlobal)`
`void`	`setGlobal(List<Global> vGlobalList)`	Sets the value of '_globalList' by copying the given Vector.
`void`	`setGlobal(Global[] vGlobalArray)`
`void`	`setGlobalCollection(List<Global> globalList)`	Deprecated.
`void`	`setName(String name)`	Sets the value of field 'name'.
`void`	`setPersistState(Boolean persistState)`
`void`	`setRuleFile(int index, String vRuleFile)`
`void`	`setRuleFile(String[] vRuleFileArray)`
`void`	`setRuleFile(List<String> vRuleFileList)`	Sets the value of '_ruleFileList' by copying the given Vector.
`void`	`setRuleFileCollection(List<String> ruleFileList)`	Deprecated.
`String`	`toString()`
`void`	`updateEngine(DroolsCorrelationEngine engine)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RuleSet
```
public RuleSet()
```
- Method Detail
  - getAssertBehaviour
```
public String getAssertBehaviour()
```
  - setAssertBehaviour
```
public void setAssertBehaviour(String assertBehaviour)
```
  - getEventProcessingMode
```
public String getEventProcessingMode()
```
  - setEventProcessingMode
```
public void setEventProcessingMode(String eventProcessingMode)
```
  - getPersistState
```
public Boolean getPersistState()
```
  - setPersistState
```
public void setPersistState(Boolean persistState)
```
  - addEvent
```
public void addEvent(String vEvent)
              throws IndexOutOfBoundsException
```
    Parameters:
    
    vEvent -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addEvent
```
public void addEvent(int index,
                     String vEvent)
              throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vEvent -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addGlobal
```
public void addGlobal(Global vGlobal)
               throws IndexOutOfBoundsException
```
    Parameters:
    
    vGlobal -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addGlobal
```
public void addGlobal(int index,
                      Global vGlobal)
               throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vGlobal -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addRuleFile
```
public void addRuleFile(String vRuleFile)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    vRuleFile -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addRuleFile
```
public void addRuleFile(int index,
                        String vRuleFile)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vRuleFile -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - enumerateEvent
```
public Enumeration<String> enumerateEvent()
```
    Method enumerateEvent.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - enumerateGlobal
```
public Enumeration<Global> enumerateGlobal()
```
    Method enumerateGlobal.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - enumerateRuleFile
```
public Enumeration<String> enumerateRuleFile()
```
    Method enumerateRuleFile.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - getAppContext
```
public String getAppContext()
```
    Returns the value of field 'appContext'.
    
    Returns:
    
    the value of field 'AppContext'.
  - getEvent
```
public String getEvent(int index)
                throws IndexOutOfBoundsException
```
    Method getEvent.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the String at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getEvent
```
public String[] getEvent()
```
    Method getEvent.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getEventCollection
```
public List<String> getEventCollection()
```
    Method getEventCollection.Returns a reference to '_eventList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getEventCount
```
public int getEventCount()
```
    Method getEventCount.
    
    Returns:
    
    the size of this collection
  - getGlobal
```
public Global getGlobal(int index)
                 throws IndexOutOfBoundsException
```
    Method getGlobal.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the Global at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getGlobal
```
public Global[] getGlobal()
```
    Method getGlobal.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getGlobalCollection
```
public List<Global> getGlobalCollection()
```
    Method getGlobalCollection.Returns a reference to '_globalList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getGlobalCount
```
public int getGlobalCount()
```
    Method getGlobalCount.
    
    Returns:
    
    the size of this collection
  - getName
```
public String getName()
```
    Returns the value of field 'name'.
    
    Returns:
    
    the value of field 'Name'.
  - getRuleFile
```
public String getRuleFile(int index)
                   throws IndexOutOfBoundsException
```
    Method getRuleFile.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the String at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getRuleFile
```
public String[] getRuleFile()
```
    Method getRuleFile.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getRuleFileCollection
```
public List<String> getRuleFileCollection()
```
    Method getRuleFileCollection.Returns a reference to '_ruleFileList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getRuleFileCount
```
public int getRuleFileCount()
```
    Method getRuleFileCount.
    
    Returns:
    
    the size of this collection
  - iterateEvent
```
public Iterator<String> iterateEvent()
```
    Method iterateEvent.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - iterateGlobal
```
public Iterator<Global> iterateGlobal()
```
    Method iterateGlobal.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - iterateRuleFile
```
public Iterator<String> iterateRuleFile()
```
    Method iterateRuleFile.
    
    Returns:
    
    an Iterator over all possible elements in this collection
  - removeAllEvent
```
public void removeAllEvent()
```
  - removeAllGlobal
```
public void removeAllGlobal()
```
  - removeAllRuleFile
```
public void removeAllRuleFile()
```
  - removeEvent
```
public boolean removeEvent(String vEvent)
```
    Method removeEvent.
    
    Parameters:
    
    vEvent -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeEventAt
```
public String removeEventAt(int index)
```
    Method removeEventAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - removeGlobal
```
public boolean removeGlobal(Global vGlobal)
```
    Method removeGlobal.
    
    Parameters:
    
    vGlobal -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeGlobalAt
```
public Global removeGlobalAt(int index)
```
    Method removeGlobalAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - removeRuleFile
```
public boolean removeRuleFile(String vRuleFile)
```
    Method removeRuleFile.
    
    Parameters:
    
    vRuleFile -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeRuleFileAt
```
public String removeRuleFileAt(int index)
```
    Method removeRuleFileAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setAppContext
```
public void setAppContext(String appContext)
```
    Sets the value of field 'appContext'.
    
    Parameters:
    
    appContext - the value of field 'appContext'.
  - setEvent
```
public void setEvent(int index,
                     String vEvent)
              throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vEvent -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setEvent
```
public void setEvent(String[] vEventArray)
```
    Parameters:
    
    vEventArray -
  - setEvent
```
public void setEvent(List<String> vEventList)
```
    Sets the value of '_eventList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vEventList - the Vector to copy.
  - setEventCollection
```
public void setEventCollection(List<String> eventList)
```
    Deprecated.
    
    Sets the value of '_eventList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    eventList - the Vector to set.
  - setGlobal
```
public void setGlobal(int index,
                      Global vGlobal)
               throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vGlobal -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setGlobal
```
public void setGlobal(Global[] vGlobalArray)
```
    Parameters:
    
    vGlobalArray -
  - setGlobal
```
public void setGlobal(List<Global> vGlobalList)
```
    Sets the value of '_globalList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vGlobalList - the Vector to copy.
  - setGlobalCollection
```
public void setGlobalCollection(List<Global> globalList)
```
    Deprecated.
    
    Sets the value of '_globalList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    globalList - the Vector to set.
  - setName
```
public void setName(String name)
```
    Sets the value of field 'name'.
    
    Parameters:
    
    name - the value of field 'name'.
  - setRuleFile
```
public void setRuleFile(int index,
                        String vRuleFile)
                 throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vRuleFile -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setRuleFile
```
public void setRuleFile(String[] vRuleFileArray)
```
    Parameters:
    
    vRuleFileArray -
  - setRuleFile
```
public void setRuleFile(List<String> vRuleFileList)
```
    Sets the value of '_ruleFileList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vRuleFileList - the Vector to copy.
  - setRuleFileCollection
```
public void setRuleFileCollection(List<String> ruleFileList)
```
    Deprecated.
    
    Sets the value of '_ruleFileList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    ruleFileList - the Vector to set.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - constructEngine
```
public CorrelationEngine constructEngine(org.springframework.core.io.Resource basePath,
                                         org.springframework.context.ApplicationContext appContext,
                                         EventIpcManager eventIpcManager,
                                         com.codahale.metrics.MetricRegistry metricRegistry)
```
  - updateEngine
```
public void updateEngine(DroolsCorrelationEngine engine)
```
  - getGlobals
```
public Map<String,Object> getGlobals(org.springframework.context.ApplicationContext context)
```
  - getInterestingEvents
```
public List<String> getInterestingEvents()
```
  - getResource
```
public org.springframework.core.io.Resource getResource(org.springframework.core.io.ResourceLoader resourceLoader,
                                                        String resourcePath)
```
  - getRuleResources
```
public List<org.springframework.core.io.Resource> getRuleResources(org.springframework.core.io.ResourceLoader resourceLoader)
```
  - getConfigLocation
```
public String getConfigLocation()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RuleSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleSet

Method Detail

getAssertBehaviour

setAssertBehaviour

getEventProcessingMode

setEventProcessingMode

getPersistState

setPersistState

addEvent

addEvent

addGlobal

addGlobal

addRuleFile

addRuleFile

enumerateEvent

enumerateGlobal

enumerateRuleFile

getAppContext

getEvent

getEvent

getEventCollection

getEventCount

getGlobal

getGlobal

getGlobalCollection

getGlobalCount

getName

getRuleFile

getRuleFile

getRuleFileCollection

getRuleFileCount

iterateEvent

iterateGlobal

iterateRuleFile

removeAllEvent

removeAllGlobal

removeAllRuleFile

removeEvent

removeEventAt

removeGlobal

removeGlobalAt

removeRuleFile

removeRuleFileAt

setAppContext

setEvent

setEvent

setEvent

setEventCollection

setGlobal

setGlobal

setGlobal

setGlobalCollection

setName

setRuleFile

setRuleFile

setRuleFile

setRuleFileCollection

hashCode

equals

constructEngine

updateEngine

getGlobals

getInterestingEvents

getResource

getRuleResources

getConfigLocation

toString