org.simbrain.workspace

Class AttributeManager

java.lang.Object

org.simbrain.workspace.AttributeManager

public class AttributeManager
extends java.lang.Object

The main usage of this class by API users is to create potential attributes (PotentialConsumer and PotentialProducer), which are in turn used to create couplings.

Most coupling creation should occur by way of the createPotential... methods in this class. The preferred method is to create a potential attribute (potential consumer or producer) which is then used to make a coupling.

A potential consumer or producer can be created in one of three ways

1. Using an AttributeType object.
2. Using a parent object, a method name, and a data type.
3. Using auxiliary arguments.

These concepts are discussed in the javadocs for Attribute.

Author:

jyoshimi

See Also:

Attribute, AttributeType, PotentialAttribute, Coupling

Constructor Summary

Constructors

Constructor and Description
AttributeManager(WorkspaceComponent parentComponent)

Method Summary

Modifier and Type	Method and Description
protected Consumer<?>	createConsumer(java.lang.Object parentObject, java.lang.String methodName, java.lang.Class<?>[] argumentDataTypes, java.lang.Object[] argumentValues, java.lang.String description) Create a consumer.
protected Consumer<?>	createConsumer(PotentialAttribute potentialAttribute) Create an actual consumer from a potential consumer.
PotentialConsumer	createPotentialConsumer(java.lang.Object baseObject, AttributeType type) Create a potential consumer using an attribute type.
PotentialConsumer	createPotentialConsumer(java.lang.Object baseObject, java.lang.String methodName, java.lang.Class<?> dataType) Create a potential consumer without auxiliary arguments.
PotentialConsumer	createPotentialConsumer(java.lang.Object baseObject, java.lang.String methodName, java.lang.Class<?>[] argDataTypes, java.lang.Object[] argValues) Create a potential consumer using auxiliary arguments.
PotentialProducer	createPotentialProducer(java.lang.Object baseObject, AttributeType type) Create a potential producer using an attribute type.
PotentialProducer	createPotentialProducer(java.lang.Object baseObject, java.lang.String methodName, java.lang.Class<?> dataType) Create a potential producer (without auxiliary arguments).
PotentialProducer	createPotentialProducer(java.lang.Object baseObject, java.lang.String methodName, java.lang.Class<?> dataType, java.lang.Class<?>[] argDataTypes, java.lang.Object[] argValues) Create a potential producer using auxiliary arguments.
protected Producer<?>	createProducer(java.lang.Object parentObject, java.lang.String methodName, java.lang.Class<?> dataType, java.lang.Class<?>[] argumentDataTypes, java.lang.Object[] argumentValues, java.lang.String description) Create a producer based on an argument.
protected Producer<?>	createProducer(PotentialAttribute potentialAttribute) Create an actual producer from a potential producer.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeManager

public AttributeManager(WorkspaceComponent parentComponent)

Parameters:

parentComponent -

Method Detail

createProducer

protected Producer<?> createProducer(java.lang.Object parentObject,
                                     java.lang.String methodName,
                                     java.lang.Class<?> dataType,
                                     java.lang.Class<?>[] argumentDataTypes,
                                     java.lang.Object[] argumentValues,
                                     java.lang.String description)

Create a producer based on an argument. This version of the method does the real work; others forward to it.

Parameters:

parentObject - base object

methodName - name of method

dataType - main data type of data (used in coupling manager)

argumentDataTypes - data types of all arguments to the method

argumentValues - arguments to the method

description - description of the producer

Returns:

the resulting producer

createProducer

protected Producer<?> createProducer(PotentialAttribute potentialAttribute)

Create an actual producer from a potential producer.

Parameters:

potentialAttribute - the potential attribute to actualize

Returns:

the resulting producer

createConsumer

protected Consumer<?> createConsumer(java.lang.Object parentObject,
                                     java.lang.String methodName,
                                     java.lang.Class<?>[] argumentDataTypes,
                                     java.lang.Object[] argumentValues,
                                     java.lang.String description)

Create a consumer. This version of the method does the real work; others forward to it. Note that, unlike createProducer, this does not have a main datatype argument, because that is implicitly the first element of argument dataTypes. For more information on these fields see the documentation for Attribute.

Parameters:

parentObject - parent object

methodName - name of method

argumentDataTypes - type of all arguments, where the first is the main data type

argumentValues - values for auxiliary arguments

description - description

Returns:

the resulting consumer

createConsumer

protected Consumer<?> createConsumer(PotentialAttribute potentialAttribute)

Create an actual consumer from a potential consumer.

Parameters:

potentialAttribute - the potential attribute to actualize

Returns:

the resulting consumer

createPotentialProducer

public PotentialProducer createPotentialProducer(java.lang.Object baseObject,
                                                 java.lang.String methodName,
                                                 java.lang.Class<?> dataType,
                                                 java.lang.Class<?>[] argDataTypes,
                                                 java.lang.Object[] argValues)

Create a potential producer using auxiliary arguments. For more information on these fields see the javadocs for Attribute.

Parameters:

baseObject - base object

methodName - name of method on base object

dataType - main data type. Type of data returned by the base object.

argDataTypes - signature of method (new Class[] {Class1, Class2,...})

argValues - values to pass to method (new Object[] {Object1, Object2,...})

Returns:

the resulting producer

createPotentialProducer

public PotentialProducer createPotentialProducer(java.lang.Object baseObject,
                                                 java.lang.String methodName,
                                                 java.lang.Class<?> dataType)

Create a potential producer (without auxiliary arguments). This is probably the main method to use in a script.

Parameters:

baseObject - base object

methodName - name of method on base object

dataType - main data type. Type of data returned by the base object.

Returns:

the resulting producer

createPotentialProducer

public PotentialProducer createPotentialProducer(java.lang.Object baseObject,
                                                 AttributeType type)

Create a potential producer using an attribute type.

Parameters:

baseObject - the base object

type - the attribute type

Returns:

the potential producer

createPotentialConsumer

public PotentialConsumer createPotentialConsumer(java.lang.Object baseObject,
                                                 java.lang.String methodName,
                                                 java.lang.Class<?>[] argDataTypes,
                                                 java.lang.Object[] argValues)

Create a potential consumer using auxiliary arguments. For more information on these fields see the javadocs for Attribute.

Parameters:

baseObject - base object

methodName - name of method on base object

argDataTypes - signature of method (new Class[] {datatype, Class1, Class2,...})

argValues - values to pass to method (new Object[] {Class1, Class2,...})

Returns:

the resulting consumer

createPotentialConsumer

public PotentialConsumer createPotentialConsumer(java.lang.Object baseObject,
                                                 java.lang.String methodName,
                                                 java.lang.Class<?> dataType)

Create a potential consumer without auxiliary arguments. This is probably the main method to use in a script.

Parameters:

baseObject - base object

methodName - name of method on base object

dataType - main data type. Type of data returned by the base object.

Returns:

the resulting consumer

createPotentialConsumer

public PotentialConsumer createPotentialConsumer(java.lang.Object baseObject,
                                                 AttributeType type)

Create a potential consumer using an attribute type.

Parameters:

baseObject - the base object

type - the attribute type

Returns:

the potential consumer