Extension

java.lang.Object
- casa.extensions.Extension

All Implemented Interfaces:

Comparable<Extension>

Direct Known Subclasses:

CodeExtension, LispScriptExtension
```
public abstract class Extension
extends Object
implements Comparable<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
This class is the top-level class for various kinds of CASA extensions.

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTR_AGENTTYPE` This attribute contains a Class object of the most general agent class for which this extension object is applicable.
`static String`	`ATTR_AUTOLOAD` This attribute is true iff it this extension should be loaded automatically at startup.
`static String`	`ATTR_DOC` This attribute contains a short doc string to be used in dialogs, mouse-overs, etc
`static String`	`ATTR_EXTENSIONNAME` This attribute contains the name that will be used to refer to this extension in menus, etc.
`static String`	`ATTR_FRAMETYPE` The frame must be a object of this type (or it's subtypes)
`protected ExtensionDescriptor`	`descriptor` The object that contains a lot of the detail about this extension, including the ATTR_* attributes.
`static String`	`TYPE_CODE` The type name for a pure java code (from a jar) extension
`static String`	`TYPE_LISPSCRIPT` The type name for Lisp script extension; the file will be executed when the Tools\|LispScript\|[ATTR_EXTENSIONNAME] menu item is selected.
`static String`	`TYPE_TAB` The type name for a java code extension that will act as a tab pane in a `AbstractProcessWindow`.

Constructor Summary

Constructors
Constructor and Description

Extension(ExtensionDescriptor d)
Every Extension object must have a descriptor.

Constructors
Constructor and Description
`Extension(ExtensionDescriptor d)` Every Extension object must have a descriptor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Extension o)` Defers to `ExtensionDescriptor.compareTo(ExtensionDescriptor)` using `descriptor`
`(package private) abstract void`	`load(AbstractInternalFrame frame, AbstractProcess agent)` Initialize this extension.
`String`	`toString()`
`(package private) int`	`validate()` Validate the descriptor with respect to this extension.
`protected int`	`validateBool(String key, Boolean defaultBool)` Utility method to validate a boolean attribute in the `descriptor`
`protected int`	`validateClass(String key, Class defaultClass)` Utility method to validate a class attribute in the `descriptor`
`protected int`	`validateString(String key, String defaultString)` Utility method to validate a String attribute in the `descriptor`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ATTR_AGENTTYPE
```
public static final String ATTR_AGENTTYPE
```
    This attribute contains a Class object of the most general agent class for which this extension object is applicable.
    
    See Also:
    
    Constant Field Values
  - ATTR_FRAMETYPE
```
public static final String ATTR_FRAMETYPE
```
    The frame must be a object of this type (or it's subtypes)
    
    See Also:
    
    Constant Field Values
  - ATTR_AUTOLOAD
```
public static final String ATTR_AUTOLOAD
```
    This attribute is true iff it this extension should be loaded automatically at startup.
    
    See Also:
    
    Constant Field Values
  - ATTR_EXTENSIONNAME
```
public static final String ATTR_EXTENSIONNAME
```
    This attribute contains the name that will be used to refer to this extension in menus, etc.
    
    See Also:
    
    Constant Field Values
  - ATTR_DOC
```
public static final String ATTR_DOC
```
    This attribute contains a short doc string to be used in dialogs, mouse-overs, etc
    
    See Also:
    
    Constant Field Values
  - TYPE_CODE
```
public static final String TYPE_CODE
```
    The type name for a pure java code (from a jar) extension
    
    See Also:
    
    Constant Field Values
  - TYPE_TAB
```
public static final String TYPE_TAB
```
    The type name for a java code extension that will act as a tab pane in a AbstractProcessWindow.
    
    See Also:
    
    Constant Field Values
  - TYPE_LISPSCRIPT
```
public static final String TYPE_LISPSCRIPT
```
    The type name for Lisp script extension; the file will be executed when the Tools|LispScript|[ATTR_EXTENSIONNAME] menu item is selected.
    
    See Also:
    
    Constant Field Values
  - descriptor
```
protected ExtensionDescriptor descriptor
```
    The object that contains a lot of the detail about this extension, including the ATTR_* attributes.
- Constructor Detail
  - Extension
```
public Extension(ExtensionDescriptor d)
```
    Every Extension object must have a descriptor.
    
    Parameters:
    
    d - The descriptor for this extension.
- Method Detail
  - validate
```
int validate()
      throws InvalidParameterException
```
    Validate the descriptor with respect to this extension.
    This method:
    - checks that the agentType field is a legitimate agent path and replaces the value with the actual class object. Default: AbstractProcess.
    - checks that the frameType field is a legitimate frame path and replaces the value with the actual class object. Default: AbstractInternalFrame.
    - checks that the autoload field is either "true" or "false" and replaces it with a boolean. The default is "false".
    - ensures that there is an extension name. The default is the class name (not fully-qualified) of the class containing the main(String[]) method.
    Returns:
    
    0 if all is good, some other integer if there were problems.
    
    Throws:
    
    InvalidParameterException - if a fatal error happens.
  - validateString
```
protected int validateString(String key,
                             String defaultString)
```
    Utility method to validate a String attribute in the descriptor
    
    Parameters:
    
    key - The key in the descriptor to validate.
    
    defaultString - The default to assign to the key is it's value is missing.
    
    Returns:
    
    0 for "OK" or "fixed it", 1 for "unexpected type, fixed it".
  - validateBool
```
protected int validateBool(String key,
                           Boolean defaultBool)
```
    Utility method to validate a boolean attribute in the descriptor
    
    Parameters:
    
    key - The key in the descriptor to validate.
    
    defaultBool - The default to assign to the key is it's value is missing or otherwise invalid.
    
    Returns:
    
    0 for "OK" or "fixed it", 1 for "unexpected type type or value, fixed it (to default)".
  - validateClass
```
protected int validateClass(String key,
                            Class defaultClass)
```
    Utility method to validate a class attribute in the descriptor
    
    Parameters:
    
    key - The key in the descriptor to validate.
    
    defaultBool - The default to assign to the key is it's value is missing or otherwise invalid.
    
    Returns:
    
    0 for "OK" or "fixed it", 1 for "unexpected type type or value, fixed it (to default)".
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    this object as Lisp code "(extension [className] (descriptor ...))"
  - compareTo
```
public int compareTo(Extension o)
```
    Defers to ExtensionDescriptor.compareTo(ExtensionDescriptor) using descriptor
    
    Specified by:
    
    compareTo in interface Comparable<Extension>
  - load
```
abstract void load(AbstractInternalFrame frame,
                   AbstractProcess agent)
```
    Initialize this 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).

Class Extension

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTR_AGENTTYPE

ATTR_FRAMETYPE

ATTR_AUTOLOAD

ATTR_EXTENSIONNAME

ATTR_DOC

TYPE_CODE

TYPE_TAB

TYPE_LISPSCRIPT

descriptor

Constructor Detail

Extension

Method Detail

validate

validateString

validateBool

validateClass

toString

compareTo

load