org.eclipse.modisco.jee.webapp.webapp30
Interface JspPropertyGroupType


public interface JspPropertyGroupType

A representation of the model object 'Jsp Property Group Type'. The jsp-property-groupType is used to group a number of files so they can be given global property information. All files so described are deemed to be JSP files. The following additional properties can be described: - Control whether EL is ignored. - Control whether scripting elements are invalid. - Indicate pageEncoding information. - Indicate that a resource is a JSP document (XML). - Prelude and Coda automatic includes. - Control whether the character sequence #{ is allowed when used as a String literal. - Control whether template text containing only whitespaces must be removed from the response output. - Indicate the default contentType information. - Indicate the default buffering model for JspWriter - Control whether error should be raised for the use of undeclared namespaces in a JSP page.

The following features are supported:

See Also:
Webapp30Package.getJspPropertyGroupType()
Generated:
Model:
extendedMetaData="name='jsp-property-groupType' kind='elementOnly'"

Method Summary
 String getBuffer()
          Returns the value of the 'Buffer' containment reference.
 String getDefaultContentType()
          Returns the value of the 'Default Content Type' containment reference.
 TrueFalseType getDeferredSyntaxAllowedAsLiteral()
          Returns the value of the 'Deferred Syntax Allowed As Literal' containment reference.
  getDescription()
          Returns the value of the 'Description' containment reference list.
  getDisplayName()
          Returns the value of the 'Display Name' containment reference list.
 TrueFalseType getElIgnored()
          Returns the value of the 'El Ignored' containment reference.
 TrueFalseType getErrorOnUndeclaredNamespace()
          Returns the value of the 'Error On Undeclared Namespace' containment reference.
  getIcon()
          Returns the value of the 'Icon' containment reference list.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
  getIncludeCoda()
          Returns the value of the 'Include Coda' containment reference list.
  getIncludePrelude()
          Returns the value of the 'Include Prelude' containment reference list.
 TrueFalseType getIsXml()
          Returns the value of the 'Is Xml' containment reference.
 String getPageEncoding()
          Returns the value of the 'Page Encoding' containment reference.
 TrueFalseType getScriptingInvalid()
          Returns the value of the 'Scripting Invalid' containment reference.
 TrueFalseType getTrimDirectiveWhitespaces()
          Returns the value of the 'Trim Directive Whitespaces' containment reference.
  getUrlPattern()
          Returns the value of the 'Url Pattern' containment reference list.
 void setBuffer(String value)
          Sets the value of the 'Buffer' containment reference.
 void setDefaultContentType(String value)
          Sets the value of the 'Default Content Type' containment reference.
 void setDeferredSyntaxAllowedAsLiteral(TrueFalseType value)
          Sets the value of the 'Deferred Syntax Allowed As Literal' containment reference.
 void setElIgnored(TrueFalseType value)
          Sets the value of the 'El Ignored' containment reference.
 void setErrorOnUndeclaredNamespace(TrueFalseType value)
          Sets the value of the 'Error On Undeclared Namespace' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setIsXml(TrueFalseType value)
          Sets the value of the 'Is Xml' containment reference.
 void setPageEncoding(String value)
          Sets the value of the 'Page Encoding' containment reference.
 void setScriptingInvalid(TrueFalseType value)
          Sets the value of the 'Scripting Invalid' containment reference.
 void setTrimDirectiveWhitespaces(TrueFalseType value)
          Sets the value of the 'Trim Directive Whitespaces' containment reference.
 

Method Detail

getDescription

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' containment reference list.
See Also:
Webapp30Package.getJspPropertyGroupType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/javaee'"

getDisplayName

 getDisplayName()
Returns the value of the 'Display Name' containment reference list. The list contents are of type DisplayNameType.

If the meaning of the 'Display Name' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Display Name' containment reference list.
See Also:
Webapp30Package.getJspPropertyGroupType_DisplayName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='display-name' namespace='http://java.sun.com/xml/ns/javaee'"

getIcon

 getIcon()
Returns the value of the 'Icon' containment reference list. The list contents are of type IconType.

If the meaning of the 'Icon' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Icon' containment reference list.
See Also:
Webapp30Package.getJspPropertyGroupType_Icon()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='icon' namespace='http://java.sun.com/xml/ns/javaee'"

getUrlPattern

 getUrlPattern()
Returns the value of the 'Url Pattern' containment reference list. The list contents are of type UrlPatternType.

If the meaning of the 'Url Pattern' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Url Pattern' containment reference list.
See Also:
Webapp30Package.getJspPropertyGroupType_UrlPattern()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='url-pattern' namespace='http://java.sun.com/xml/ns/javaee'"

getElIgnored

TrueFalseType getElIgnored()
Returns the value of the 'El Ignored' containment reference. Can be used to easily set the isELIgnored property of a group of JSP pages. By default, the EL evaluation is enabled for Web Applications using a Servlet 2.4 or greater web.xml, and disabled otherwise.

Returns:
the value of the 'El Ignored' containment reference.
See Also:
setElIgnored(TrueFalseType), Webapp30Package.getJspPropertyGroupType_ElIgnored()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='el-ignored' namespace='http://java.sun.com/xml/ns/javaee'"

setElIgnored

void setElIgnored(TrueFalseType value)
Sets the value of the 'El Ignored' containment reference.

Parameters:
value - the new value of the 'El Ignored' containment reference.
See Also:
getElIgnored()
Generated:

getPageEncoding

String getPageEncoding()
Returns the value of the 'Page Encoding' containment reference. The valid values of page-encoding are those of the pageEncoding page directive. It is a translation-time error to name different encodings in the pageEncoding attribute of the page directive of a JSP page and in a JSP configuration element matching the page. It is also a translation-time error to name different encodings in the prolog or text declaration of a document in XML syntax and in a JSP configuration element matching the document. It is legal to name the same encoding through mulitple mechanisms.

Returns:
the value of the 'Page Encoding' containment reference.
See Also:
setPageEncoding(org.eclipse.modisco.jee.webapp.webapp30.String), Webapp30Package.getJspPropertyGroupType_PageEncoding()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='page-encoding' namespace='http://java.sun.com/xml/ns/javaee'"

setPageEncoding

void setPageEncoding(String value)
Sets the value of the 'Page Encoding' containment reference.

Parameters:
value - the new value of the 'Page Encoding' containment reference.
See Also:
getPageEncoding()
Generated:

getScriptingInvalid

TrueFalseType getScriptingInvalid()
Returns the value of the 'Scripting Invalid' containment reference. Can be used to easily disable scripting in a group of JSP pages. By default, scripting is enabled.

Returns:
the value of the 'Scripting Invalid' containment reference.
See Also:
setScriptingInvalid(TrueFalseType), Webapp30Package.getJspPropertyGroupType_ScriptingInvalid()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='scripting-invalid' namespace='http://java.sun.com/xml/ns/javaee'"

setScriptingInvalid

void setScriptingInvalid(TrueFalseType value)
Sets the value of the 'Scripting Invalid' containment reference.

Parameters:
value - the new value of the 'Scripting Invalid' containment reference.
See Also:
getScriptingInvalid()
Generated:

getIsXml

TrueFalseType getIsXml()
Returns the value of the 'Is Xml' containment reference. If true, denotes that the group of resources that match the URL pattern are JSP documents, and thus must be interpreted as XML documents. If false, the resources are assumed to not be JSP documents, unless there is another property group that indicates otherwise.

Returns:
the value of the 'Is Xml' containment reference.
See Also:
setIsXml(TrueFalseType), Webapp30Package.getJspPropertyGroupType_IsXml()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='is-xml' namespace='http://java.sun.com/xml/ns/javaee'"

setIsXml

void setIsXml(TrueFalseType value)
Sets the value of the 'Is Xml' containment reference.

Parameters:
value - the new value of the 'Is Xml' containment reference.
See Also:
getIsXml()
Generated:

getIncludePrelude

 getIncludePrelude()
Returns the value of the 'Include Prelude' containment reference list. The list contents are of type PathType. The include-prelude element is a context-relative path that must correspond to an element in the Web Application. When the element is present, the given path will be automatically included (as in an include directive) at the beginning of each JSP page in this jsp-property-group.

Returns:
the value of the 'Include Prelude' containment reference list.
See Also:
Webapp30Package.getJspPropertyGroupType_IncludePrelude()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='include-prelude' namespace='http://java.sun.com/xml/ns/javaee'"

getIncludeCoda

 getIncludeCoda()
Returns the value of the 'Include Coda' containment reference list. The list contents are of type PathType. The include-coda element is a context-relative path that must correspond to an element in the Web Application. When the element is present, the given path will be automatically included (as in an include directive) at the end of each JSP page in this jsp-property-group.

Returns:
the value of the 'Include Coda' containment reference list.
See Also:
Webapp30Package.getJspPropertyGroupType_IncludeCoda()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='include-coda' namespace='http://java.sun.com/xml/ns/javaee'"

getDeferredSyntaxAllowedAsLiteral

TrueFalseType getDeferredSyntaxAllowedAsLiteral()
Returns the value of the 'Deferred Syntax Allowed As Literal' containment reference. The character sequence #{ is reserved for EL expressions. Consequently, a translation error occurs if the #{ character sequence is used as a String literal, unless this element is enabled (true). Disabled (false) by default.

Returns:
the value of the 'Deferred Syntax Allowed As Literal' containment reference.
See Also:
setDeferredSyntaxAllowedAsLiteral(TrueFalseType), Webapp30Package.getJspPropertyGroupType_DeferredSyntaxAllowedAsLiteral()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='deferred-syntax-allowed-as-literal' namespace='http://java.sun.com/xml/ns/javaee'"

setDeferredSyntaxAllowedAsLiteral

void setDeferredSyntaxAllowedAsLiteral(TrueFalseType value)
Sets the value of the 'Deferred Syntax Allowed As Literal' containment reference.

Parameters:
value - the new value of the 'Deferred Syntax Allowed As Literal' containment reference.
See Also:
getDeferredSyntaxAllowedAsLiteral()
Generated:

getTrimDirectiveWhitespaces

TrueFalseType getTrimDirectiveWhitespaces()
Returns the value of the 'Trim Directive Whitespaces' containment reference. Indicates that template text containing only whitespaces must be removed from the response output. It has no effect on JSP documents (XML syntax). Disabled (false) by default.

Returns:
the value of the 'Trim Directive Whitespaces' containment reference.
See Also:
setTrimDirectiveWhitespaces(TrueFalseType), Webapp30Package.getJspPropertyGroupType_TrimDirectiveWhitespaces()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='trim-directive-whitespaces' namespace='http://java.sun.com/xml/ns/javaee'"

setTrimDirectiveWhitespaces

void setTrimDirectiveWhitespaces(TrueFalseType value)
Sets the value of the 'Trim Directive Whitespaces' containment reference.

Parameters:
value - the new value of the 'Trim Directive Whitespaces' containment reference.
See Also:
getTrimDirectiveWhitespaces()
Generated:

getDefaultContentType

String getDefaultContentType()
Returns the value of the 'Default Content Type' containment reference. The valid values of default-content-type are those of the contentType page directive. It specifies the default response contentType if the page directive does not include a contentType attribute.

Returns:
the value of the 'Default Content Type' containment reference.
See Also:
setDefaultContentType(org.eclipse.modisco.jee.webapp.webapp30.String), Webapp30Package.getJspPropertyGroupType_DefaultContentType()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='default-content-type' namespace='http://java.sun.com/xml/ns/javaee'"

setDefaultContentType

void setDefaultContentType(String value)
Sets the value of the 'Default Content Type' containment reference.

Parameters:
value - the new value of the 'Default Content Type' containment reference.
See Also:
getDefaultContentType()
Generated:

getBuffer

String getBuffer()
Returns the value of the 'Buffer' containment reference. The valid values of buffer are those of the buffer page directive. It specifies if buffering should be used for the output to response, and if so, the size of the buffer to use.

Returns:
the value of the 'Buffer' containment reference.
See Also:
setBuffer(org.eclipse.modisco.jee.webapp.webapp30.String), Webapp30Package.getJspPropertyGroupType_Buffer()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='buffer' namespace='http://java.sun.com/xml/ns/javaee'"

setBuffer

void setBuffer(String value)
Sets the value of the 'Buffer' containment reference.

Parameters:
value - the new value of the 'Buffer' containment reference.
See Also:
getBuffer()
Generated:

getErrorOnUndeclaredNamespace

TrueFalseType getErrorOnUndeclaredNamespace()
Returns the value of the 'Error On Undeclared Namespace' containment reference. The default behavior when a tag with unknown namespace is used in a JSP page (regular syntax) is to silently ignore it. If set to true, then an error must be raised during the translation time when an undeclared tag is used in a JSP page. Disabled (false) by default.

Returns:
the value of the 'Error On Undeclared Namespace' containment reference.
See Also:
setErrorOnUndeclaredNamespace(TrueFalseType), Webapp30Package.getJspPropertyGroupType_ErrorOnUndeclaredNamespace()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='error-on-undeclared-namespace' namespace='http://java.sun.com/xml/ns/javaee'"

setErrorOnUndeclaredNamespace

void setErrorOnUndeclaredNamespace(TrueFalseType value)
Sets the value of the 'Error On Undeclared Namespace' containment reference.

Parameters:
value - the new value of the 'Error On Undeclared Namespace' containment reference.
See Also:
getErrorOnUndeclaredNamespace()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), Webapp30Package.getJspPropertyGroupType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: