Interface IModelFactory
- All Known Implementing Classes:
StandardModelFactory
Interface defining model factories.
A Model Factory can be obtained at custom processor artifacts by means of
ITemplateContext.getModelFactory()
, and then used for creating and modifying models
(IModel
) and events (ITemplateEvent
.
The StandardModelFactory
implementation will be used by default.
- Since:
- 3.0.0
- Author:
- Daniel Fernández
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncreateCDATASection
(CharSequence content) Create a new CDATA Section event, containing the specified contents.createCloseElementTag
(String elementName) Create a new close tag, non-synthetic and non-unmatched.createCloseElementTag
(String elementName, boolean synthetic, boolean unmatched) Create a new close tag.createComment
(CharSequence content) Create a new Comment event, containing the specified contents.createDocType
(String publicId, String systemId) Create a DOCTYPE clause event with the specified public ID and system ID.createDocType
(String keyword, String elementName, String publicId, String systemId, String internalSubset) Create a DOCTYPE clause event, specifying all its components.Create a DOCTYPE clause event for HTML5 (no type, no public or system id).Creates a new, empty model.createModel
(ITemplateEvent event) Creates a new model containing only one event (initially).createOpenElementTag
(String elementName) Create a new open element tag, non-synthetic.createOpenElementTag
(String elementName, boolean synthetic) Create a new open element tag.createOpenElementTag
(String elementName, String attributeName, String attributeValue) Create a new open element tag, non-synthetic, specifying one attribute.createOpenElementTag
(String elementName, String attributeName, String attributeValue, boolean synthetic) Create a new open element tag, specifying one attribute.createOpenElementTag
(String elementName, Map<String, String> attributes, AttributeValueQuotes attributeValueQuotes, boolean synthetic) Create a new open element tag, specifying several attributes.createProcessingInstruction
(String target, String content) Create a new Processing Instruction event, specifying its target and content.createStandaloneElementTag
(String elementName) Create a new standalone element tag, non synthetic and minimized.createStandaloneElementTag
(String elementName, boolean synthetic, boolean minimized) Create a new standalone element tag.createStandaloneElementTag
(String elementName, String attributeName, String attributeValue) Create a new standalone element tag, non synthetic and minimized, specifying one attribute.createStandaloneElementTag
(String elementName, String attributeName, String attributeValue, boolean synthetic, boolean minimized) Create a new standalone element tag, specifying one attribute.createStandaloneElementTag
(String elementName, Map<String, String> attributes, AttributeValueQuotes attributeValueQuotes, boolean synthetic, boolean minimized) Create a new standalone element tag, specifying several attributes.createText
(CharSequence text) Create a new Text event, specifying its contents.createXMLDeclaration
(String version, String encoding, String standalone) Create a new XML Declaration event, specifying values for all its attributes.parse
(TemplateData ownerTemplate, String template) Parse the template specified as String and return the result as a model.<T extends IProcessableElementTag>
TremoveAttribute
(T tag, String attributeName) Create a new tag removing an existing attribute.<T extends IProcessableElementTag>
TremoveAttribute
(T tag, String prefix, String name) Create a new tag removing an existing attribute.<T extends IProcessableElementTag>
TremoveAttribute
(T tag, AttributeName attributeName) Create a new tag removing an existing attribute.<T extends IProcessableElementTag>
TreplaceAttribute
(T tag, AttributeName oldAttributeName, String attributeName, String attributeValue) Create a new tag object replacing an attribute in the original tag with another one.<T extends IProcessableElementTag>
TreplaceAttribute
(T tag, AttributeName oldAttributeName, String attributeName, String attributeValue, AttributeValueQuotes attributeValueQuotes) Create a new tag object replacing an attribute in the original tag with another one, also specifying the type of quotes to be used for representing the attribute value.<T extends IProcessableElementTag>
TsetAttribute
(T tag, String attributeName, String attributeValue) Create a new tag object that adds a new attribute to the existing ones in a specified tag.<T extends IProcessableElementTag>
TsetAttribute
(T tag, String attributeName, String attributeValue, AttributeValueQuotes attributeValueQuotes) Create a new tag object that adds a new attribute to the existing ones in a specified tag, also specifying the type of quotes to be used for representing the attribute value.
-
Method Details
-
createModel
IModel createModel()Creates a new, empty model.
- Returns:
- the new model.
-
createModel
Creates a new model containing only one event (initially).
- Parameters:
event
- the event to be put into the newly created model.- Returns:
- the new model.
-
parse
Parse the template specified as String and return the result as a model.
Note the
template
argument specified here is the template content itself, not a name to be resolved by a template resolver. TheownerTemplate
argument is mandatory, and specifies the template that is being processed and as a part of which process the String template is being parsed.- Parameters:
ownerTemplate
- the template being processed, for which the String template is being parsed into a model object.template
- the String containing the contents of the template to be parsed.- Returns:
- the
IModel
representing the parsed template.
-
createCDATASection
Create a new CDATA Section event, containing the specified contents.
- Parameters:
content
- the content (i.e. without prefix or suffix) of the new CDATA Section.- Returns:
- the new CDATA Section.
-
createComment
Create a new Comment event, containing the specified contents.
- Parameters:
content
- the content (i.e. without prefix or suffix) of the new Comment.- Returns:
- the new Comment.
-
createHTML5DocType
IDocType createHTML5DocType()Create a DOCTYPE clause event for HTML5 (no type, no public or system id).
- Returns:
- the new DOCTYPE, corresponding with an HTML5 DOCTYPE clause.
-
createDocType
Create a DOCTYPE clause event with the specified public ID and system ID.
- Parameters:
publicId
- the public ID to be applied (might be null).systemId
- the system ID to be applied (might be null if public ID is also null).- Returns:
- the new DOCTPYE.
-
createDocType
IDocType createDocType(String keyword, String elementName, String publicId, String systemId, String internalSubset) Create a DOCTYPE clause event, specifying all its components.
- Parameters:
keyword
- the keyword value (should beDOCTYPE
, but case might vary).elementName
- the root element name.publicId
- the public ID (might be null).systemId
- the system ID (might be null).internalSubset
- the internal subset (might be null).- Returns:
- the new DOCTYPE.
-
createProcessingInstruction
Create a new Processing Instruction event, specifying its target and content.
- Parameters:
target
- the target value.content
- the content value.- Returns:
- the new Processing Instruction.
-
createText
Create a new Text event, specifying its contents.
- Parameters:
text
- the text contents.- Returns:
- the new Text.
-
createXMLDeclaration
Create a new XML Declaration event, specifying values for all its attributes.
- Parameters:
version
- the version value (might be null).encoding
- the encoding value (might be null).standalone
- the standalone value (might be null).- Returns:
- the new XML Declaration.
-
createStandaloneElementTag
Create a new standalone element tag, non synthetic and minimized.
This is equivalent to calling
createStandaloneElementTag(String, boolean, boolean)
withfalse
as a value forsynthetic
andtrue
as a value forminimized
.- Parameters:
elementName
- the element name.- Returns:
- the standalone tag.
-
createStandaloneElementTag
IStandaloneElementTag createStandaloneElementTag(String elementName, String attributeName, String attributeValue) Create a new standalone element tag, non synthetic and minimized, specifying one attribute.
This is equivalent to calling
createStandaloneElementTag(String, String, String, boolean, boolean)
withfalse
as a value forsynthetic
andtrue
as a value forminimized
.- Parameters:
elementName
- the element name.attributeName
- the name of the attribute to be added to the tag.attributeValue
- the value of the attribute to be added to the tag.- Returns:
- the standalone tag.
-
createStandaloneElementTag
IStandaloneElementTag createStandaloneElementTag(String elementName, boolean synthetic, boolean minimized) Create a new standalone element tag.
- Parameters:
elementName
- the element name.synthetic
- whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.minimized
- whether the tag is minimized or not, i.e. whether it ends in/>
or simply>
.- Returns:
- the standalone tag.
-
createStandaloneElementTag
IStandaloneElementTag createStandaloneElementTag(String elementName, String attributeName, String attributeValue, boolean synthetic, boolean minimized) Create a new standalone element tag, specifying one attribute.
- Parameters:
elementName
- the element name.attributeName
- the name of the attribute to be added to the tag.attributeValue
- the value of the attribute to be added to the tag.synthetic
- whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.minimized
- whether the tag is minimized or not, i.e. whether it ends in/>
or simply>
.- Returns:
- the standalone tag.
-
createStandaloneElementTag
IStandaloneElementTag createStandaloneElementTag(String elementName, Map<String, String> attributes, AttributeValueQuotes attributeValueQuotes, boolean synthetic, boolean minimized) Create a new standalone element tag, specifying several attributes.
- Parameters:
elementName
- the element name.attributes
- the map of attribute names and values.attributeValueQuotes
- the type of quotes to be used for representing the attribute values.synthetic
- whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.minimized
- whether the tag is minimized or not, i.e. whether it ends in/>
or simply>
.- Returns:
- the standalone tag.
-
createOpenElementTag
Create a new open element tag, non-synthetic.
This is equivalent to calling
createOpenElementTag(String, boolean)
withfalse
as a value forsynthetic
.- Parameters:
elementName
- the element name.- Returns:
- the open tag.
-
createOpenElementTag
IOpenElementTag createOpenElementTag(String elementName, String attributeName, String attributeValue) Create a new open element tag, non-synthetic, specifying one attribute.
This is equivalent to calling
createOpenElementTag(String, String, String, boolean)
withfalse
as a value forsynthetic
.- Parameters:
elementName
- the element name.attributeName
- the name of the attribute to be added to the tag.attributeValue
- the value of the attribute to be added to the tag.- Returns:
- the open tag.
-
createOpenElementTag
Create a new open element tag.
- Parameters:
elementName
- the element name.synthetic
- whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.- Returns:
- the open tag.
-
createOpenElementTag
IOpenElementTag createOpenElementTag(String elementName, String attributeName, String attributeValue, boolean synthetic) Create a new open element tag, specifying one attribute.
- Parameters:
elementName
- the element name.attributeName
- the name of the attribute to be added to the tag.attributeValue
- the value of the attribute to be added to the tag.synthetic
- whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.- Returns:
- the open tag.
-
createOpenElementTag
IOpenElementTag createOpenElementTag(String elementName, Map<String, String> attributes, AttributeValueQuotes attributeValueQuotes, boolean synthetic) Create a new open element tag, specifying several attributes.
- Parameters:
elementName
- the element name.attributes
- the map of attribute names and values.attributeValueQuotes
- the type of quotes to be used for representing the attribute values.synthetic
- whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.- Returns:
- the open tag.
-
createCloseElementTag
Create a new close tag, non-synthetic and non-unmatched.
This is equivalent to calling
createCloseElementTag(String, boolean, boolean)
withfalse
as a value forsynthetic
and alsofalse
as a value forunmatched
.- Parameters:
elementName
- the element name.- Returns:
- the close tag.
-
createCloseElementTag
Create a new close tag.
- Parameters:
elementName
- the element name.synthetic
- whether the tag is synthetic or not. Synthetic tags are used for balancing of markup and will not appear on output.unmatched
- whether this tag should be considered unmatched, i.e. there is no corresponding previous open tag for it.- Returns:
- the close tag.
-
setAttribute
<T extends IProcessableElementTag> T setAttribute(T tag, String attributeName, String attributeValue) Create a new tag object that adds a new attribute to the existing ones in a specified tag.
Note that this method should create a new object because
ITemplateEvent
implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.- Type Parameters:
T
- the type of the original and new tags.- Parameters:
tag
- the original tag.attributeName
- the name of the attribute to be added.attributeValue
- the value of the attribute to be added.- Returns:
- the new tag.
-
setAttribute
<T extends IProcessableElementTag> T setAttribute(T tag, String attributeName, String attributeValue, AttributeValueQuotes attributeValueQuotes) Create a new tag object that adds a new attribute to the existing ones in a specified tag, also specifying the type of quotes to be used for representing the attribute value.
Note that this method should create a new object because
ITemplateEvent
implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.- Type Parameters:
T
- the type of the original and new tags.- Parameters:
tag
- the original tag.attributeName
- the name of the attribute to be added.attributeValue
- the value of the attribute to be added.attributeValueQuotes
- the type of quotes to be used for representing the attribute value.- Returns:
- the new tag.
-
replaceAttribute
<T extends IProcessableElementTag> T replaceAttribute(T tag, AttributeName oldAttributeName, String attributeName, String attributeValue) Create a new tag object replacing an attribute in the original tag with another one.
Note that this method should create a new object because
ITemplateEvent
implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.If the attribute being replaced does not exist, the new one will be created as if
setAttribute(IProcessableElementTag, String, String)
was called instead. If the old attribute does exist, its position in the tag as well as its quote type will be used.- Type Parameters:
T
- the type of the original and new tags.- Parameters:
tag
- the original tag.oldAttributeName
- the name of the attribute to be replaced.attributeName
- the name of the attribute to be added.attributeValue
- the value of the attribute to be added.- Returns:
- the new tag.
-
replaceAttribute
<T extends IProcessableElementTag> T replaceAttribute(T tag, AttributeName oldAttributeName, String attributeName, String attributeValue, AttributeValueQuotes attributeValueQuotes) Create a new tag object replacing an attribute in the original tag with another one, also specifying the type of quotes to be used for representing the attribute value.
Note that this method should create a new object because
ITemplateEvent
implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.If the attribute being replaced does not exist, the new one will be created as if
setAttribute(IProcessableElementTag, String, String)
was called instead. If the old attribute does exist, its position in the tag will be used.- Type Parameters:
T
- the type of the original and new tags.- Parameters:
tag
- the original tag.oldAttributeName
- the name of the attribute to be replaced.attributeName
- the name of the attribute to be added.attributeValue
- the value of the attribute to be added.attributeValueQuotes
- the type of quotes to be used for representing the attribute value.- Returns:
- the new tag.
-
removeAttribute
Create a new tag removing an existing attribute.
Note that this method should create a new object because
ITemplateEvent
implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.If the attribute being removed does not exist, nothing will be done and the same tag object will be returned.
- Type Parameters:
T
- the type of the original and new tags.- Parameters:
tag
- the original tag.attributeName
- the name of the attribute to be removed.- Returns:
- the new tag.
-
removeAttribute
Create a new tag removing an existing attribute.
Note that this method should create a new object because
ITemplateEvent
implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.If the attribute being removed does not exist, nothing will be done and the same tag object will be returned.
- Type Parameters:
T
- the type of the original and new tags.- Parameters:
tag
- the original tag.prefix
- the prefix of the attribute (might be null).name
- the name of the attribute.- Returns:
- the new tag.
-
removeAttribute
Create a new tag removing an existing attribute.
Note that this method should create a new object because
ITemplateEvent
implementations are immutable. Also, the created tag will be of the same type (i.e. standalone or open) as the specified as argument.If the attribute being removed does not exist, nothing will be done and the same tag object will be returned.
- Type Parameters:
T
- the type of the original and new tags.- Parameters:
tag
- the original tag.attributeName
- the attribute name.- Returns:
- the new tag.
-