eu.baltrad.beast.admin.objects.routes.Route Class Reference

Base object used when manipulating different routes. More...

Inheritance diagram for eu.baltrad.beast.admin.objects.routes.Route:

Public Member Functions
	Route ()
	Constructor.
	Route (String name)
	Constructor.
String	getName ()
void	setName (String name)
List< String >	getRecipients ()
void	setRecipients (List< String > recipients)
boolean	isActive ()
void	setActive (boolean active)
String	getAuthor ()
void	setAuthor (String author)
String	getDescription ()
void	setDescription (String description)
boolean	validate ()
	Validates this route so that it follows the conventions.
abstract boolean	isValid ()
void	fromRouteDefinition (RouteDefinition def)
	Fills a route from the route definition.
IRule	toRule (IRouterManager routerManager)
	Creates a rule from self using the provided router manager.

Detailed Description

Base object used when manipulating different routes.

See RouteDefinition

Author

anders

Constructor & Destructor Documentation

Route() [1/2]

eu.baltrad.beast.admin.objects.routes.Route.Route ( )

inline

Constructor.

Route() [2/2]

eu.baltrad.beast.admin.objects.routes.Route.Route ( String name )

inline

Constructor.

Member Function Documentation

fromRouteDefinition()

void eu.baltrad.beast.admin.objects.routes.Route.fromRouteDefinition ( RouteDefinition def )

inline

Fills a route from the route definition.

Parameters

def	the route definition

Reimplemented in eu.baltrad.beast.admin.objects.routes.AcrrRoute, eu.baltrad.beast.admin.objects.routes.CompositeRoute, eu.baltrad.beast.admin.objects.routes.DBTrimAgeRoute, eu.baltrad.beast.admin.objects.routes.DBTrimCountRoute, eu.baltrad.beast.admin.objects.routes.DistributionRoute, eu.baltrad.beast.admin.objects.routes.GmapRoute, eu.baltrad.beast.admin.objects.routes.GraRoute, eu.baltrad.beast.admin.objects.routes.GroovyRoute, eu.baltrad.beast.admin.objects.routes.ScansunRoute, eu.baltrad.beast.admin.objects.routes.Site2DRoute, eu.baltrad.beast.admin.objects.routes.VolumeRoute, and eu.baltrad.beast.admin.objects.routes.WrwpRoute.

getAuthor()

String eu.baltrad.beast.admin.objects.routes.Route.getAuthor ( )

inline

Returns

the author

getDescription()

String eu.baltrad.beast.admin.objects.routes.Route.getDescription ( )

inline

Returns

the description

getName()

String eu.baltrad.beast.admin.objects.routes.Route.getName ( )

inline

Returns

the name

getRecipients()

List< String > eu.baltrad.beast.admin.objects.routes.Route.getRecipients ( )

inline

Returns

the recipients

isActive()

boolean eu.baltrad.beast.admin.objects.routes.Route.isActive ( )

inline

Returns

the active

isValid()

abstract boolean eu.baltrad.beast.admin.objects.routes.Route.isValid ( )

abstract

Reimplemented in eu.baltrad.beast.admin.objects.routes.BasicRoute.

setActive()

void eu.baltrad.beast.admin.objects.routes.Route.setActive ( boolean active )

inline

Parameters

active

the active to set

setAuthor()

void eu.baltrad.beast.admin.objects.routes.Route.setAuthor ( String author )

inline

Parameters

author

the author to set

setDescription()

void eu.baltrad.beast.admin.objects.routes.Route.setDescription ( String description )

inline

Parameters

description

the description to set

setName()

void eu.baltrad.beast.admin.objects.routes.Route.setName ( String name )

inline

Parameters

name	the name to set

setRecipients()

void eu.baltrad.beast.admin.objects.routes.Route.setRecipients ( List< String > recipients )

inline

Parameters

recipients

the recipients to set

toRule()

IRule eu.baltrad.beast.admin.objects.routes.Route.toRule ( IRouterManager routerManager )

inline

Creates a rule from self using the provided router manager.

Parameters

routerManager

the router manager

Returns

the rule

Reimplemented in eu.baltrad.beast.admin.objects.routes.AcrrRoute, eu.baltrad.beast.admin.objects.routes.CompositeRoute, eu.baltrad.beast.admin.objects.routes.DBTrimAgeRoute, eu.baltrad.beast.admin.objects.routes.DBTrimCountRoute, eu.baltrad.beast.admin.objects.routes.DistributionRoute, eu.baltrad.beast.admin.objects.routes.GmapRoute, eu.baltrad.beast.admin.objects.routes.GraRoute, eu.baltrad.beast.admin.objects.routes.GroovyRoute, eu.baltrad.beast.admin.objects.routes.ScansunRoute, eu.baltrad.beast.admin.objects.routes.Site2DRoute, eu.baltrad.beast.admin.objects.routes.VolumeRoute, and eu.baltrad.beast.admin.objects.routes.WrwpRoute.

validate()

boolean eu.baltrad.beast.admin.objects.routes.Route.validate ( )

inline

Validates this route so that it follows the conventions.

Returns

true if valid, false otherwise

---

The documentation for this class was generated from the following file:

• src/eu/baltrad/beast/admin/objects/routes/Route.java