casa.extensions

Class LispScriptExtension

java.lang.Object

casa.extensions.Extension

casa.extensions.LispScriptExtension

All Implemented Interfaces:

Comparable<Extension>

public class LispScriptExtension
extends Extension

Title: CASA Agent Infrastructure

Copyright: Copyright (c) 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Company: Knowledge Science Group, Department of Computer Science, University of Calgary

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_ONCE If the attribute is "true", then the script is run without an agent at startup and will not appear in the menu.
static String	ATTR_ONCE_PER_AGENT If this attribute is "true", then the script is run for each agent that matches its Extension.ATTR_AGENTTYPE at agent startup.

Fields inherited from class casa.extensions.Extension

ATTR_AGENTTYPE, ATTR_AUTOLOAD, ATTR_DOC, ATTR_EXTENSIONNAME, ATTR_FRAMETYPE, descriptor, TYPE_CODE, TYPE_LISPSCRIPT, TYPE_TAB

Constructor Summary

Constructors

Constructor and Description
LispScriptExtension(ExtensionDescriptor d)

Method Summary

Modifier and Type	Method and Description
(package private) void	load(AbstractInternalFrame frame, AbstractProcess agent) Executes the lisp file: If ATTR_ONCE is set and the frame and agent are null.
(package private) int	validate() defaults ATTR_EXTENSIONNAME to the souce file name calls the parent version ensures at ATTR_ONCE and ATTR_ONCE_PER_AGENT are not both true (throws if they are both true).

Methods inherited from class casa.extensions.Extension

compareTo, toString, validateBool, validateClass, validateString

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_ONCE

public static final String ATTR_ONCE

If the attribute is "true", then the script is run without an agent at startup and will not appear in the menu.

See Also:

Constant Field Values

ATTR_ONCE_PER_AGENT

public static final String ATTR_ONCE_PER_AGENT

If this attribute is "true", then the script is run for each agent that matches its Extension.ATTR_AGENTTYPE at agent startup.

See Also:

Constant Field Values

Constructor Detail

LispScriptExtension

public LispScriptExtension(ExtensionDescriptor d)

Parameters:

d -

Method Detail

load

void load(AbstractInternalFrame frame,
          AbstractProcess agent)

Executes the lisp file:

• If ATTR_ONCE is set and the frame and agent are null.
• If ATTR_ONCE_PER_AGENT is set and the frame is null, but the agent is not.
• If neither ATTR_ONCE nor ATTR_ONCE_PER_AGENT is set and both the frame and agent are not null.

Specified by:

load in class Extension

Parameters:

frame - The frame this extension should attach itself to. (May be null).

agent - The agent this extension should associate itself with. (May be null).

See Also:

Extension.load(casa.ui.AbstractInternalFrame, casa.AbstractProcess)

validate

int validate()
      throws InvalidParameterException

• defaults ATTR_EXTENSIONNAME to the souce file name
• calls the parent version
• ensures at ATTR_ONCE and ATTR_ONCE_PER_AGENT are not both true (throws if they are both true).

Overrides:

validate in class Extension

Returns:

0 if all is good, some other integer if there were problems.

Throws:

InvalidParameterException - if a fatal error happens.

See Also:

Extension.validate()