com.espertech.esper.common.client.module

Class Module

java.lang.Object

com.espertech.esper.common.client.module.Module

All Implemented Interfaces:

java.io.Serializable

public class Module
extends java.lang.Object
implements java.io.Serializable

Represent a deployment unit consisting of deployment declarative information (module name, uses and imports) as well as EPL statements represented by ModuleItem. May have an additional user object and archive name and uri pointing to the module source attached.

The module URI gets initialized with the filename, resource or URL being read, however may be overridden and has not further meaning to the deployment.

The archive name and user object are opportunities to attach additional deployment information.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Module() Ctor.
Module(java.lang.String name, java.lang.String uri, java.util.Set<java.lang.String> uses, java.util.Set<java.lang.String> imports, java.util.List<ModuleItem> items, java.lang.String moduleText) Ctor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArchiveName() Returns the name of the archive this module originated from, or null if not applicable.
java.util.Set<java.lang.String>	getImports() Returns the imports defined by the module.
java.util.List<ModuleItem>	getItems() Returns a list of statements (some may be comments only) that make up the module.
java.lang.String	getModuleText() Returns module text.
java.lang.Object	getModuleUserObjectCompileTime() Returns the optional user object that may be attached to the module.
java.lang.String	getName() Returns the module name, if provided.
java.lang.String	getUri() Returns the module URI if provided.
java.util.Set<java.lang.String>	getUses() Returns the dependencies the module may have on other modules.
void	setArchiveName(java.lang.String archiveName) Set the name of the archive this module originated from, or null if not applicable.
void	setImports(java.util.Set<java.lang.String> imports) Sets the imports defined by the module.
void	setItems(java.util.List<ModuleItem> items) Sets a list of statements (some may be comments only) that make up the module.
void	setModuleText(java.lang.String moduleText) Sets module text.
void	setModuleUserObjectCompileTime(java.io.Serializable moduleUserObjectCompileTime) Sets an optional user object that may be attached to the module.
void	setName(java.lang.String name) Sets the module name or null if none provided.
void	setUri(java.lang.String uri) Sets the module URI or null if none provided.
void	setUses(java.util.Set<java.lang.String> uses) Sets the dependencies the module may have on other modules.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Module

public Module(java.lang.String name,
              java.lang.String uri,
              java.util.Set<java.lang.String> uses,
              java.util.Set<java.lang.String> imports,
              java.util.List<ModuleItem> items,
              java.lang.String moduleText)

Ctor.

Parameters:

name - module name

uri - module uri

uses - names of modules that this module depends on

imports - the Java class imports

items - EPL statements

moduleText - text of module

Module

public Module()

Ctor.

Method Detail

getArchiveName

public java.lang.String getArchiveName()

Returns the name of the archive this module originated from, or null if not applicable.

Returns:

archive name

setArchiveName

public void setArchiveName(java.lang.String archiveName)

Set the name of the archive this module originated from, or null if not applicable.

Parameters:

archiveName - archive name

getModuleUserObjectCompileTime

public java.lang.Object getModuleUserObjectCompileTime()

Returns the optional user object that may be attached to the module.

Returns:

user object

setModuleUserObjectCompileTime

public void setModuleUserObjectCompileTime(java.io.Serializable moduleUserObjectCompileTime)

Sets an optional user object that may be attached to the module.

Parameters:

moduleUserObjectCompileTime - user object

getName

public java.lang.String getName()

Returns the module name, if provided.

Returns:

module name

setName

public void setName(java.lang.String name)

Sets the module name or null if none provided.

Parameters:

name - module name

getUri

public java.lang.String getUri()

Returns the module URI if provided.

Returns:

module URI

setUri

public void setUri(java.lang.String uri)

Sets the module URI or null if none provided.

Parameters:

uri - of module

getUses

public java.util.Set<java.lang.String> getUses()

Returns the dependencies the module may have on other modules.

Returns:

module dependencies

setUses

public void setUses(java.util.Set<java.lang.String> uses)

Sets the dependencies the module may have on other modules.

Parameters:

uses - module dependencies

getItems

public java.util.List<ModuleItem> getItems()

Returns a list of statements (some may be comments only) that make up the module.

Returns:

statements

setItems

public void setItems(java.util.List<ModuleItem> items)

Sets a list of statements (some may be comments only) that make up the module.

Parameters:

items - statements

getImports

public java.util.Set<java.lang.String> getImports()

Returns the imports defined by the module.

Returns:

module imports

setImports

public void setImports(java.util.Set<java.lang.String> imports)

Sets the imports defined by the module.

Parameters:

imports - module imports

getModuleText

public java.lang.String getModuleText()

Returns module text.

Returns:

text

setModuleText

public void setModuleText(java.lang.String moduleText)

Sets module text.

Parameters:

moduleText - text to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object