ecologylab.services.messages.cf
Class SeedCf

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.services.messages.ServiceMessage
              ecologylab.services.messages.RequestMessage
                  ecologylab.services.messages.cf.SeedCf

All Implemented Interfaces:

OptimizationTypes, XMLTranslationExceptionTypes, java.lang.Comparable<ServiceMessage>

public class SeedCf
extends RequestMessage

Pass a set of seeds to combinFormation's agents. Version for client only:

data slot definitions only with no other functionality.

Author:

andruid

Nested Class Summary

Nested classes/interfaces inherited from class ecologylab.xml.ElementState

ElementState.ClassToCollectionMap, ElementState.DeclarationStyle, ElementState.xml_attribute, ElementState.xml_class, ElementState.xml_classes, ElementState.xml_collection, ElementState.xml_leaf, ElementState.xml_map, ElementState.xml_nested, ElementState.xml_tag

Field Summary

protected int	handleMultipleRequests If there are multiple seeding requests in a single session, how should we handle it?
static int	MULTIPLE_REQUESTSTS_ASK_USER
static java.lang.String[]	MULTIPLE_REQUESTSTS_DIALOG_OPTIONS
static int	MULTIPLE_REQUESTSTS_IGNORE
static int	MULTIPLE_REQUESTSTS_MIX
static int	MULTIPLE_REQUESTSTS_REPLACE
protected SeedSet	seedSet The set of seeds being passed to the combinFormation information collecting agent.
protected int	sessionNumber Indicates which CFSession the seeding message effect, in case there are more than one.

Fields inherited from class ecologylab.services.messages.ServiceMessage

sender, timeStamp, uid

Fields inherited from class ecologylab.xml.ElementState

CDATA, ESTIMATE_CHARS_PER_FIELD, FLOATING_PRECISION_OFF, MARSHALLING_PARAMS, NORMAL, UTF16, UTF16_LE, UTF8, XML_FILE_HEADER

Fields inherited from interface ecologylab.xml.OptimizationTypes

BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED

Fields inherited from interface ecologylab.xml.XMLTranslationExceptionTypes

FILE_NOT_FOUND, IO_EXCEPTION, NULL_PURL, UNKNOWN

Constructor Summary

SeedCf()
Default constructor.

Method Summary

void	add(Seed seed) Add a Seed to the request, through its seedSet.
void	clear() Remove entries from the SeedSet, if there is one.
ResponseMessage	performService(Scope objectRegistry, java.lang.String sessionId) Dummy version -- will never get called, because this version lives only on the client, and the real functionality is on the server.
SeedSet	seedSet() Access the SeedSet slot.
void	setHandleMultipleRequests(int handleMultipleRequests)

Methods inherited from class ecologylab.services.messages.RequestMessage

isDisposable, performService

Methods inherited from class ecologylab.services.messages.ServiceMessage

compareTo, getSender, getTimeStamp, getUid, setSender, setUid, stampTime

Methods inherited from class ecologylab.xml.ElementState

addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, createChildHook, fieldToXMLOptimizations, floatingPrecision, getCollection, getElementStateById, getMap, getNestedNameSpace, getTextNodeString, leafElementFieldNames, lookupNestedNameSpace, optimizations, parent, postTranslationProcessingHook, preTranslationProcessingHook, recycle, setDeclarationStyle, setFieldUsingTypeRegistry, setFloatingPrecision, setParent, setUseDOMForTranslateTo, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXMLCharSequence, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOMCharSequence, translateFromXMLDOMCharSequence, translateFromXMLRootNode, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateToDOM, translateToXML, translateToXML, translateToXML, translateToXML, writePrettyXML, writePrettyXML, writePrettyXML

Methods inherited from class ecologylab.generic.Debug

classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, toString, warning, warning, weird, weird

Methods inherited from class java.lang.Object

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

Field Detail

sessionNumber

protected int sessionNumber

Indicates which CFSession the seeding message effect, in case there are more than one. The default, 0, indicates the first session that was created, or if none have been, to create one now, and then use it.

seedSet

protected SeedSet seedSet

The set of seeds being passed to the combinFormation information collecting agent.

handleMultipleRequests

protected int handleMultipleRequests

If there are multiple seeding requests in a single session, how should we handle it?

MULTIPLE_REQUESTSTS_DIALOG_OPTIONS

public static final java.lang.String[] MULTIPLE_REQUESTSTS_DIALOG_OPTIONS

MULTIPLE_REQUESTSTS_IGNORE

public static final int MULTIPLE_REQUESTSTS_IGNORE

See Also:

Constant Field Values

MULTIPLE_REQUESTSTS_REPLACE

public static final int MULTIPLE_REQUESTSTS_REPLACE

See Also:

Constant Field Values

MULTIPLE_REQUESTSTS_MIX

public static final int MULTIPLE_REQUESTSTS_MIX

See Also:

Constant Field Values

MULTIPLE_REQUESTSTS_ASK_USER

public static final int MULTIPLE_REQUESTSTS_ASK_USER

See Also:

Constant Field Values

Constructor Detail

SeedCf

public SeedCf()

Default constructor.

Method Detail

seedSet

public SeedSet seedSet()

Access the SeedSet slot. If it is currently null, create a new SeedSet, and set the slot to its value.

Returns:

An instance of SeedSet, from the SeedSet slot. Never null.

add

public void add(Seed seed)

Add a Seed to the request, through its seedSet.

Parameters:

seed -

performService

public ResponseMessage performService(Scope objectRegistry,
                                      java.lang.String sessionId)

Dummy version -- will never get called, because this version lives only on the client, and the real functionality is on the server.

Specified by:

performService in class RequestMessage

Parameters:

objectRegistry -

sessionId - TODO

Returns:

null

clear

public void clear()

Remove entries from the SeedSet, if there is one.

setHandleMultipleRequests

public void setHandleMultipleRequests(int handleMultipleRequests)