|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.esper.client.Configuration
public class Configuration
An instance of Configuration allows the application
to specify properties to be used when
creating a EPServiceProvider. Usually an application will create
a single Configuration, then get one or more instances of
EPServiceProvider
via EPServiceProviderManager
.
The Configuration is meant
only as an initialization-time object. EPServiceProviders are
immutable and do not retain any association back to the
Configuration.
The format of an Esper XML configuration file is defined in
esper-configuration-1.0.xsd.
Field Summary | |
---|---|
protected static java.lang.String |
ESPER_DEFAULT_CONFIG
Default name of the configuration file. |
protected java.util.Map<java.lang.String,java.lang.String> |
eventClasses
Map of event name and fully-qualified Java class name. |
protected java.util.List<java.lang.String> |
imports
The java-style class and package name imports that will be used to resolve partial class names. |
Constructor Summary | |
---|---|
Configuration()
Constructs an empty configuration. |
Method Summary | |
---|---|
void |
addEventTypeAlias(java.lang.String eventTypeAlias,
java.lang.String javaEventClass)
Add an alias for an event type. |
void |
addImport(java.lang.String autoImport)
Add an import (a class or package). |
Configuration |
configure()
Use the configuration specified in an application resource named esper.cfg.xml. |
Configuration |
configure(org.w3c.dom.Document document)
Use the mappings and properties specified in the given XML document. |
Configuration |
configure(java.io.File configFile)
Use the configuration specified in the given application file. |
Configuration |
configure(java.lang.String resource)
Use the configuration specified in the given application resource. |
Configuration |
configure(java.net.URL url)
Use the configuration specified by the given URL. |
protected Configuration |
doConfigure(org.w3c.dom.Document doc)
Parse the W3C DOM document. |
protected Configuration |
doConfigure(java.io.InputStream stream,
java.lang.String resourceName)
Use the configuration specified in the given input stream. |
protected java.io.InputStream |
getConfigurationInputStream(java.lang.String resource)
Get the configuration file as an InputStream. |
java.util.Map<java.lang.String,java.lang.String> |
getEventTypeAliases()
Returns the mapping of event type alias to event types. |
java.util.List<java.lang.String> |
getImports()
Returns the class and package imports. |
protected static java.io.InputStream |
getResourceAsStream(java.lang.String resource)
Returns an input stream from an application resource in the classpath. |
protected void |
reset()
Reset to an empty configuration. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String ESPER_DEFAULT_CONFIG
protected java.util.Map<java.lang.String,java.lang.String> eventClasses
protected java.util.List<java.lang.String> imports
Constructor Detail |
---|
public Configuration()
Method Detail |
---|
public void addEventTypeAlias(java.lang.String eventTypeAlias, java.lang.String javaEventClass)
eventTypeAlias
- is the alias for the event typejavaEventClass
- fully-qualified class name of the event typepublic void addImport(java.lang.String autoImport)
autoImport
- - the import to addpublic java.util.Map<java.lang.String,java.lang.String> getEventTypeAliases()
public java.util.List<java.lang.String> getImports()
public Configuration configure() throws EPException
EPException
- thrown to indicate error reading configurationpublic Configuration configure(java.lang.String resource) throws EPException
resource
- if the file name of the resource
EPException
- thrown to indicate error reading configurationprotected java.io.InputStream getConfigurationInputStream(java.lang.String resource) throws EPException
resource
- is the resource name
EPException
- thrown to indicate error reading configurationpublic Configuration configure(java.net.URL url) throws EPException
url
- URL from which you wish to load the configuration
EPException
public Configuration configure(java.io.File configFile) throws EPException
configFile
- File from which you wish to load the configuration
EPException
public Configuration configure(org.w3c.dom.Document document) throws EPException
document
- an XML document from which you wish to load the configuration
EPException
- if there is problem in accessing the document.protected Configuration doConfigure(java.io.InputStream stream, java.lang.String resourceName) throws EPException
stream
- Inputstream to be read fromresourceName
- The name to use in warning/error messages
EPException
protected Configuration doConfigure(org.w3c.dom.Document doc) throws EPException
doc
- to parse
EPException
protected static java.io.InputStream getResourceAsStream(java.lang.String resource)
resource
- to get input stream for
protected void reset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |