org.obe.client.api.repository
Class FunctionSetMetaData

java.lang.Object
  org.obe.client.api.repository.AbstractMetaData
      org.obe.client.api.repository.ImplClassMetaData
          org.obe.client.api.repository.FunctionSetMetaData

All Implemented Interfaces:

java.io.Serializable

public final class FunctionSetMetaData

extends ImplClassMetaData

Describes a user-defined plug-in evaluator function set.

Author:

Adrian Price

See Also:

Serialized Form

Field Summary

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

FunctionSetMetaData()
Constructs function set meta-data.

FunctionSetMetaData(java.lang.String id, java.lang.String displayName, java.lang.String description, java.lang.String docUrl, java.lang.String author, java.lang.String implClass, java.lang.String nsPrefix, java.lang.String nsURI)
Constructs function meta-data.

Method Summary

java.lang.Object	createInstance(org.xml.sax.EntityResolver entityResolver) Returns an instance of the class that implements the extension functions.
java.lang.String	getNsPrefix()
java.lang.String	getNsURI()
void	setNsPrefix(java.lang.String nsPrefix)
void	setNsURI(java.lang.String nsURI)
java.lang.String	toString()

Methods inherited from class org.obe.client.api.repository.ImplClassMetaData

getImplClass, getImplCtorSig, setImplClass, setImplCtorSig

Methods inherited from class org.obe.client.api.repository.AbstractMetaData

createInstance, createInstance, getAuthor, getDescription, getDisplayName, getDocUrl, getId, 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

Constructor Detail

FunctionSetMetaData

public FunctionSetMetaData()

Constructs function set meta-data.

FunctionSetMetaData

public FunctionSetMetaData(java.lang.String id,
                           java.lang.String displayName,
                           java.lang.String description,
                           java.lang.String docUrl,
                           java.lang.String author,
                           java.lang.String implClass,
                           java.lang.String nsPrefix,
                           java.lang.String nsURI)

Constructs function meta-data. Function set implementation classes must have a public no-args ctor.

Parameters:

id - The function set ID.

displayName - The display name.

description - Textual description of this function set.

docUrl - URL for documentation.

author - Author's name.

implClass - The fully qualified name of the function set implementation class.

nsPrefix - The namespace prefix to use.

nsURI - The namespace URI to use.

Method Detail

createInstance

public java.lang.Object createInstance(org.xml.sax.EntityResolver entityResolver)
                                throws RepositoryException

Returns an instance of the class that implements the extension functions.

Specified by:

createInstance in class AbstractMetaData

Parameters:

entityResolver -

Returns:

Implementation class.

Throws:

RepositoryException - if the class could not be found.

getNsPrefix

public java.lang.String getNsPrefix()

setNsPrefix

public void setNsPrefix(java.lang.String nsPrefix)

getNsURI

public java.lang.String getNsURI()

setNsURI

public void setNsURI(java.lang.String nsURI)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractMetaData