org.lsst.ccs.command

Class RouteSelectionCommandSet

java.lang.Object

org.lsst.ccs.command.CompositeCommandSet

org.lsst.ccs.command.RouteSelectionCommandSet

All Implemented Interfaces:

CommandSet

public class RouteSelectionCommandSet
extends CompositeCommandSet

A CommandSet that acts as a filter and deals with changing the active route.

Author:

turri

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RouteSelectionCommandSet.BuiltIns
static class	RouteSelectionCommandSet.SetGetTargetCommands

Constructor Summary

Constructors

Constructor and Description
RouteSelectionCommandSet()
RouteSelectionCommandSet(CompositeCommandSet parentCommandSet)

Method Summary

Modifier and Type	Method and Description
void	addRoutingCommandSet(String route, String path, CommandSet parent) Add a command set at the specified path.
boolean	containsPath(String path)
Map<String,CommandSet>	getCommandSetsForRoute(String root) Return all the command sets below root
int	getRouteLevel(String route)
Map<String,RoutingCommandSet>	getRoutes() Return a list of routes and their associated RoutingCommandSet
void	removeRoute(String route) Remove all paths that start with or are equal to route.
void	setRouteCommandTypeVisibility(String route, Command.CommandType... types)
void	setRouteLevel(String route, int level) Set the level for the given route and all the sub targets defined by this route.

Methods inherited from class org.lsst.ccs.command.CompositeCommandSet

add, getCommandDictionary, getCommandSets, invoke, remove

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteSelectionCommandSet

public RouteSelectionCommandSet()

RouteSelectionCommandSet

public RouteSelectionCommandSet(CompositeCommandSet parentCommandSet)

Method Detail

setRouteLevel

public void setRouteLevel(String route,
                          int level)

Set the level for the given route and all the sub targets defined by this route.

Parameters:

route -

level -

getRouteLevel

public int getRouteLevel(String route)

setRouteCommandTypeVisibility

public void setRouteCommandTypeVisibility(String route,
                                          Command.CommandType... types)

addRoutingCommandSet

public void addRoutingCommandSet(String route,
                                 String path,
                                 CommandSet parent)

Add a command set at the specified path. This internally creates a RoutingCommandSet, the route of which is specified by the route parameter. WHAT IS THE DIFFERENCE BETWEEN PATH AND ROUTE?

Parameters:

route - the route corresponding to the CommandSet

path - the command set path

parent - the parent command set

removeRoute

public void removeRoute(String route)

Remove all paths that start with or are equal to route.

Parameters:

route - the root route to remove.

containsPath

public boolean containsPath(String path)

Parameters:

path -

Returns:

getRoutes

public Map<String,RoutingCommandSet> getRoutes()

Return a list of routes and their associated RoutingCommandSet

Returns:

getCommandSetsForRoute

public Map<String,CommandSet> getCommandSetsForRoute(String root)

Return all the command sets below root

Parameters:

root - the root route.

Returns:

a Map of CommandSets. Note that the values are not RoutingCommandSet objects, but their corresponding inner CommandSet