Class mozile.save.extract.Instruction

Object
   |
   +--mozile.save.extract.Instruction

class mozile.save.extract.Instruction

Defined in extract.js

Field Detail

select

String select

The HTML target to select.

target

String target

The XML target to use.

value

String value

A string to assign to the target.

mozile.save.extract.Instruction

mozile.save.extract.Instruction()

An Instruction object does the work of converting HTML to XML. It has a target which is an element or attribute in the XML output. It also has a selector which selects parts of the HTML input, or a string value. The target is assigned the value.

Examples of instructions:

• Create an element: "newElement"
• Assign all children to an element: "newElement=*"
• Assign all text to an element: "newElement=text()"
• Assign a string to an element: "newElement='string content'"
• Assign a string to an attribute: "

execute

Element execute(<Element> element, <Element> container)

Does the work of manipulating the target. Takes an HTML element as its context and an XML container to attach new content to. TODO: Clean up and generalize. Use proper XPaths.

Parameters:
element - An HTML element to use as input.
container - An XML element to attach output to.

Returns:
Either the given container or a newly created container is returned.

getType

String getType()

Returns the type of this instruction. TODO: Define types more clearly.

toString

String toString()

A convenience method to dump the properties of this Instruction object.