com.webobjects.appserver.parser.woml
Interface WOMLNamespace

All Known Implementing Classes:

WOMLAbstractNamespace, WOMLDefaultNamespace, WOMLWebObjectsNamespace, WOMLWebObjectsQualifierNamespace

public interface WOMLNamespace

Method Summary

boolean	canGenerateElement(WOMLElement element) Returns true if the receiver can generate a WOElement from the information contained in the given WOMLElement.
void	contributeToDeclaration(WOMLElement element, WOElement template, WOMutableDeclaration declaration, NSArray languages, WOAssociationFactory associationFactory) Contributes from the receiving namespace into the declaration given.
WOElement	generateElement(WOMLElement element, WOElement template, WOMutableDeclaration declaration, NSArray languages, WOAssociationFactory associationFactory) Returns the constructed WOElement from the given WOMLElement, template (child WOElement of the WOMLElement) and declaration.
String	getNamespaceId() Returns the namespace identifier for this namespace.

Method Detail

getNamespaceId

String getNamespaceId()

Returns the namespace identifier for this namespace.

Returns:

canGenerateElement

boolean canGenerateElement(WOMLElement element)

Returns true if the receiver can generate a WOElement from the information contained in the given WOMLElement.

Parameters:

element -

Returns:

generateElement

WOElement generateElement(WOMLElement element,
                          WOElement template,
                          WOMutableDeclaration declaration,
                          NSArray languages,
                          WOAssociationFactory associationFactory)
                          throws WOMLElementGenerationException

Returns the constructed WOElement from the given WOMLElement, template (child WOElement of the WOMLElement) and declaration. The declaration will have been set previously via contributeToDeclaration by all contributors. This method is called if the receiver returns true from canGenerateElement() for a particular element. There can be at most one element generator for a given WOMLElement, so this method has total control over the WOElement generated.

Parameters:

element -

template -

declaration -

associationFactory -

Returns:

Throws:

WOMLElementGenerationException

contributeToDeclaration

void contributeToDeclaration(WOMLElement element,
                             WOElement template,
                             WOMutableDeclaration declaration,
                             NSArray languages,
                             WOAssociationFactory associationFactory)
                             throws WOMLElementGenerationException

Contributes from the receiving namespace into the declaration given. Normally this means contributing binding values. This method is called when the target namespace appears in either the attributes or the tag name of the target WOMLElement.

Parameters:

element -

template -

declaration -

associationFactory -

Throws:

WOMLElementGenerationException