brahms.base.system
Class GetJavaAttributeValueActivity

java.lang.Object
  gov.nasa.arc.brahms.vm.api.jac.AbstractExternalActivity
      brahms.base.system.GetJavaAttributeValueActivity

All Implemented Interfaces:

IExternalActivity

public class GetJavaAttributeValueActivity
extends AbstractExternalActivity

The GetJavaAttributeValueActivity allows a Brahms active instance to retrieve the value for a primitive-type or java.io.Serializable attribute of a java object. The Brahms java activity declaration takes four parameters:

• javaObject - A bound java.io.Serializable object variable.
• javaAttributeName - a string variable or literal that is the name of the attribute to be set.
• valueFormat - optional, string, a directive to format the return value (UPPERCASE, LOWERCASE, ...)
• returnValue - An unbound primitive-type or java.io.Serializble variable that will be assigned the value returned from the method invocation
• result - An unbound boolean variable that will be given the value true if the activity completes successfully

This activity uses the java reflection package to invoke the appropriate method on the given java object. The name of the method to be invoked will be constructed by first capitalizing the String value of the javaAttributeName parameter the adding the prefix "is" for boolean return types and "get" for all other return types. e.g. if the javaAttributeName passed to this activity is "name" and the returnValue parameter is a variable of type 'string' then this activity will attempt to invoke a method with the signature 'public String getName()' and bind the returned value to the variable.

Version:

$Revision: 1.1 $ $Date: 2007/10/10 14:02:53 $ $Author: rvhoof $

Author:

Mike Scott

Field Summary

static org.apache.log4j.Logger

LOGGER

Constructor Summary

GetJavaAttributeValueActivity()

Method Summary

void	doActivity() Performs the activity

Methods inherited from class gov.nasa.arc.brahms.vm.api.jac.AbstractExternalActivity

assertBelief, assertFact, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, getContext, getModel, getName, getParameter, getParameterCount, getPerformedBy, getVMController, getWorldState, isValidTruthValue, retractBelief, retractFact, send, send, send, send, setActivity, setProperties, toString

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.apache.log4j.Logger LOGGER

Constructor Detail

GetJavaAttributeValueActivity

public GetJavaAttributeValueActivity()

Method Detail

doActivity

public void doActivity()
                throws ExternalException

Performs the activity

Specified by:

doActivity in interface IExternalActivity

Specified by:

doActivity in class AbstractExternalActivity

Throws:

ExternalException - if an internal error occurs