org.obe.client.api.repository
Class ToolAgentMetaData

java.lang.Object
  extended byorg.obe.client.api.repository.AbstractMetaData
      extended byorg.obe.client.api.repository.ToolAgentMetaData
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
DocumentHandlerMetaData, DummyToolMetaData, JavaMethodMetaData, NativeExecutableMetaData, NoImplementationToolAgentMetaData, ScriptMetaData, UpdateProcessAttributesMetaData, WebServiceMetaData, XFormMetaData, XMLRPCServiceMetaData

public abstract class ToolAgentMetaData
extends AbstractMetaData

Describes a user-defined tool agent. Different tool types extend this class with the additional meta data required to instantiate the tool agent itself.

Author:
Adrian Price
See Also:
Serialized Form

Field Summary
protected  FormalParameter[] _formalParameters
           
 
Fields inherited from class org.obe.client.api.repository.AbstractMetaData
_author, _description, _displayName, _docUrl, _id, _threadsafe, _type, allowInheritance, EMPTY_ARGS, NO_ARGS_SIG
 
Constructor Summary
protected ToolAgentMetaData()
           
protected ToolAgentMetaData(java.lang.String id, java.lang.String displayName, java.lang.String description, java.lang.String docUrl, java.lang.String author, boolean threadsafe)
          Constructs tool meta-data.
 
Method Summary
 java.lang.Object createInstance(org.xml.sax.EntityResolver entityResolver)
           
 java.lang.Object createInstance(org.xml.sax.EntityResolver entityResolver, java.lang.Object args)
           
 FormalParameter[] getFormalParameter()
           
 void init()
          Provides an opportunity for metadata classes to perform post-load initialization.
abstract  ToolAgentMetaData introspect(ExternalReference extRef, org.xml.sax.EntityResolver entityResolver)
          Introspects a reference to an externally defined tool or service.
 void setFormalParameter(FormalParameter[] formalParameters)
           
 java.lang.String toString()
           
 
Methods inherited from class org.obe.client.api.repository.AbstractMetaData
createInstance, getAuthor, getDescription, getDisplayName, getDocUrl, getId, getImplClass, getImplCtorSig, getThreadsafe, getType, isThreadsafe, setAuthor, setDescription, setDisplayName, setDocUrl, setId, setThreadsafe, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_formalParameters

protected FormalParameter[] _formalParameters
Constructor Detail

ToolAgentMetaData

protected ToolAgentMetaData()

ToolAgentMetaData

protected ToolAgentMetaData(java.lang.String id,
                            java.lang.String displayName,
                            java.lang.String description,
                            java.lang.String docUrl,
                            java.lang.String author,
                            boolean threadsafe)
Constructs tool meta-data.

Parameters:
id - The tool ID.
displayName - The display name.
description - Textual description of this tool.
docUrl - URL for documentation.
author - Author's name.
threadsafe - true if instances of impClass
Method Detail

createInstance

public java.lang.Object createInstance(org.xml.sax.EntityResolver entityResolver)
                                throws RepositoryException
Specified by:
createInstance in class AbstractMetaData
Throws:
RepositoryException

createInstance

public java.lang.Object createInstance(org.xml.sax.EntityResolver entityResolver,
                                       java.lang.Object args)
                                throws RepositoryException
Overrides:
createInstance in class AbstractMetaData
Throws:
RepositoryException

getFormalParameter

public FormalParameter[] getFormalParameter()

setFormalParameter

public void setFormalParameter(FormalParameter[] formalParameters)

init

public void init()
Provides an opportunity for metadata classes to perform post-load initialization. The ToolAgentFactory calls this method on each ToolAgentMetaData object registered with it as part of the final phase of initialization. Client code should not call this method.


introspect

public abstract ToolAgentMetaData introspect(ExternalReference extRef,
                                             org.xml.sax.EntityResolver entityResolver)
                                      throws RepositoryException
Introspects a reference to an externally defined tool or service. If the associated tool agent type can handle the reference, the method returns the meta-data required to instantiate such a tool agent.

Parameters:
extRef - The external tool reference.
entityResolver -
Returns:
Configured tool meta-data, or null if this tool type cannot handle this reference.
Throws:
RepositoryException

toString

public java.lang.String toString()
Overrides:
toString in class AbstractMetaData


SourceForge.net Logo OBE-1.0 Copyright (C) 2002-2006 Adrian Price. All Rights Reserved.