com.webobjects.appserver.parser
Class WOComponentTemplateParser

java.lang.Object
  com.webobjects.appserver.parser.WOComponentTemplateParser

Direct Known Subclasses:

WOBundleComponentTemplateParser, WOHTMLTemplateParser, WOMLTemplateParser

public abstract class WOComponentTemplateParser
extends Object

Used for parsing traditional .wo components. Formerly a private class, moved to com.webobjects.appserver.parser.* as of WebObjects 5.4.

Since:

5.4

Nested Class Summary

static class

WOComponentTemplateParser.Factory Factory method for new parser.

Constructor Summary

WOComponentTemplateParser(String referenceName, String HTMLString, String declarationString, NSArray languages, WOAssociationFactory associationFactory, WOMLNamespaceProvider namespaceProvider)

Method Summary

WOAssociationFactory	associationFactory()
String	declarationString()
String	htmlString()
NSArray	languages()
WOMLNamespaceProvider	namespaceProvider()
abstract WOElement	parse()
String	referenceName()
void	setDeclarationString(String value)
void	setHtmlString(String value)
void	setLanguages(NSArray languages)
static void	setWOHTMLTemplateParserClassName(String className)
protected boolean	shouldThrowException()
static WOElement	templateWithHTMLAndDeclaration(String someHTML, String declarations, NSArray languages) Deprecated. Use templateWithHTMLAndDeclaration(String, String, String, String, NSArray, WOAssociationFactory, WOMLNamespaceProvider) instead
static WOElement	templateWithHTMLAndDeclaration(String referenceName, String someHTML, String declarations, NSArray languages, WOAssociationFactory associationFactory, WOMLNamespaceProvider namespaceProvider) Deprecated. Use templateWithHTMLAndDeclaration(String, String, String, String, NSArray, WOAssociationFactory, WOMLNamespaceProvider) instead
static WOElement	templateWithHTMLAndDeclaration(String frameworkName, String referenceName, String someHTML, String declarations, NSArray languages, WOAssociationFactory associationFactory, WOMLNamespaceProvider namespaceProvider) Creates a new parser and parse the component
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WOComponentTemplateParser

public WOComponentTemplateParser(String referenceName,
                                 String HTMLString,
                                 String declarationString,
                                 NSArray languages,
                                 WOAssociationFactory associationFactory,
                                 WOMLNamespaceProvider namespaceProvider)

Parameters:

HTMLString -

declarationString -

languages -

Method Detail

parse

public abstract WOElement parse()
                         throws ClassNotFoundException,
                                WODeclarationFormatException,
                                WOHTMLFormatException

Returns:

Parsed component

Throws:

WODeclarationFormatException

WOHTMLFormatException

ClassNotFoundException

referenceName

public String referenceName()

Returns:

reference name

Since:

5.4

htmlString

public String htmlString()

Returns:

html in string form

Since:

5.4

setHtmlString

public void setHtmlString(String value)

Parameters:

value -

Since:

5.4

declarationString

public String declarationString()

Returns:

wod declaration string

Since:

5.4

setDeclarationString

public void setDeclarationString(String value)

Parameters:

value -

Since:

5.4

languages

public NSArray languages()

Returns:

array of languages

Since:

5.4

setLanguages

public void setLanguages(NSArray languages)

Parameters:

languages -

Since:

5.4

associationFactory

public WOAssociationFactory associationFactory()

Since:

5.4

namespaceProvider

public WOMLNamespaceProvider namespaceProvider()

Since:

5.4

shouldThrowException

protected boolean shouldThrowException()

Returns:

true if application.parser.shouldThrowExceptions property set

toString

public String toString()

Overrides:

toString in class Object

setWOHTMLTemplateParserClassName

public static void setWOHTMLTemplateParserClassName(String className)

Parameters:

className -

templateWithHTMLAndDeclaration

@Deprecated
public static WOElement templateWithHTMLAndDeclaration(String someHTML,
                                                                  String declarations,
                                                                  NSArray languages)
                                                throws WODeclarationFormatException,
                                                       WOHTMLFormatException,
                                                       ClassNotFoundException

Deprecated. Use templateWithHTMLAndDeclaration(String, String, String, String, NSArray, WOAssociationFactory, WOMLNamespaceProvider) instead

Parameters:

referenceName -

someHTML -

declarations -

languages -

associationFactory -

namespaceProvider -

Returns:

Throws:

WODeclarationFormatException

WOHTMLFormatException

ClassNotFoundException

templateWithHTMLAndDeclaration

@Deprecated
public static WOElement templateWithHTMLAndDeclaration(String referenceName,
                                                                  String someHTML,
                                                                  String declarations,
                                                                  NSArray languages,
                                                                  WOAssociationFactory associationFactory,
                                                                  WOMLNamespaceProvider namespaceProvider)
                                                throws WODeclarationFormatException,
                                                       WOHTMLFormatException,
                                                       ClassNotFoundException

Deprecated. Use templateWithHTMLAndDeclaration(String, String, String, String, NSArray, WOAssociationFactory, WOMLNamespaceProvider) instead

Creates a new parser and parse the component

Parameters:

referenceName - A name to use in reference to lend context to any exceptions thrown, or null if none is desired. For example, WOComponent would pass its name().

someHTML - HTML string to create the template of the component

declarations - declaration on the template of the component

languages - list of languages in specific order

associationFactory - The association factory to use when parsing the template, pass WOApplication.application().associationFactory() for the default behavior.

namespaceProvider - The namespace provider to be used when parsing the template, pass WOApplication.application().namespaceProvider() for the default behavior.

Returns:

parsed element

Throws:

WODeclarationFormatException

WOHTMLFormatException

ClassNotFoundException

templateWithHTMLAndDeclaration

public static WOElement templateWithHTMLAndDeclaration(String frameworkName,
                                                       String referenceName,
                                                       String someHTML,
                                                       String declarations,
                                                       NSArray languages,
                                                       WOAssociationFactory associationFactory,
                                                       WOMLNamespaceProvider namespaceProvider)
                                                throws WODeclarationFormatException,
                                                       WOHTMLFormatException,
                                                       ClassNotFoundException

Creates a new parser and parse the component

Parameters:

frameworkName - framework name of the component to parse

referenceName - A name to use in reference to lend context to any exceptions thrown, or null if none is desired. For example, WOComponent would pass its name().

someHTML - HTML string to create the template of the component

declarations - declaration on the template of the component

languages - list of languages in specific order

associationFactory - The association factory to use when parsing the template, pass WOApplication.application().associationFactory() for the default behavior.

namespaceProvider - The namespace provider to be used when parsing the template, pass WOApplication.application().namespaceProvider() for the default behavior.

Returns:

parsed element

Throws:

WODeclarationFormatException

WOHTMLFormatException

ClassNotFoundException