cas.config
Class JCasFunctionTag

java.lang.Object
  cas.xml.AbstractCasSaxTagHandler
      cas.config.JCasFunctionTag

All Implemented Interfaces:

CasSaxTagHandler

public class JCasFunctionTag

extends AbstractCasSaxTagHandler

Configuration object for an extended authorization with a function.

Version:

1.0

Author:

Ralph Schuster

Field Summary

protected String	name The function name
protected static String	NAME The tag name
protected static String[]	parents The parents
protected Set	returnValues The return values

Constructor Summary

JCasFunctionTag()
Creates a new instance of JCasFunctionTag

Method Summary

protected boolean	checkReturnValue(String s) Checks the return value and translates it to a boolean.
protected AbstractCasSaxTagHandler	createHandler(String tagName, Attributes attributes) Returns a new instance of the handler for the specified sub tag.
boolean	execute(Statement st, String uid, String scheme, String dummyTable) Executes the function.
String	getName() Returns the function name.
String[]	getParentTagNames() Returns the tag names of all possible parents.
protected String[]	getSubTagNames() Returns the tag names that can appear within this handler but actually do not contain other tags.
String	getTagName() Returns the tag name this handler will take care of.
void	tagCompleted() Validates the configuration.

Methods inherited from class cas.xml.AbstractCasSaxTagHandler

characters, clear, endElement, getHandler, getSubHandler, getSubHandlerCount, getSubHandlers, getSubTag, getSubTag, getSubTagCount, getSubTags, ignoresUnknownTags, setAttributes, setIgnoreUnknownTags, startElement

Methods inherited from class java.lang.Object

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

Field Detail

NAME

protected static String NAME

The tag name

parents

protected static String[] parents

The parents

name

protected String name

The function name

returnValues

protected Set returnValues

The return values

Constructor Detail

JCasFunctionTag

public JCasFunctionTag()

Creates a new instance of JCasFunctionTag

Method Detail

createHandler

protected AbstractCasSaxTagHandler createHandler(String tagName,
                                                 Attributes attributes)

Description copied from class: AbstractCasSaxTagHandler

Returns a new instance of the handler for the specified sub tag.

Specified by:

createHandler in class AbstractCasSaxTagHandler

Parameters:

tagName - - name of the sub tag

Returns:

new instance of sub tag handler or null

getParentTagNames

public String[] getParentTagNames()

Description copied from class: AbstractCasSaxTagHandler

Returns the tag names of all possible parents.

Specified by:

getParentTagNames in class AbstractCasSaxTagHandler

Returns:

- the tag names of possible parents

getSubTagNames

protected String[] getSubTagNames()

Description copied from class: AbstractCasSaxTagHandler

Returns the tag names that can appear within this handler but actually do not contain other tags.

Overrides:

getSubTagNames in class AbstractCasSaxTagHandler

Returns:

- all tag names that represent simple tags.

getTagName

public String getTagName()

Description copied from interface: CasSaxTagHandler

Returns the tag name this handler will take care of.

Returns:

- a tag name.

tagCompleted

public void tagCompleted()
                  throws SAXException

Description copied from class: AbstractCasSaxTagHandler

Validates the configuration. By default this method does nothing but handlers should override to check the values.

Specified by:

tagCompleted in interface CasSaxTagHandler

Overrides:

tagCompleted in class AbstractCasSaxTagHandler

Throws:

SAXException

getName

public String getName()

Returns the function name.

execute

public boolean execute(Statement st,
                       String uid,
                       String scheme,
                       String dummyTable)
                throws SQLException

Executes the function.

Parameters:

st - - statement on database

uid - - user id of requesting user

scheme - - scheme name

Throws:

SQLException

checkReturnValue

protected boolean checkReturnValue(String s)

Checks the return value and translates it to a boolean.