xpe(4) | AFNIX Service | xpe(4) |
NAME¶
xpe - xml processing environment serviceXML PROCESSING ENVIRONMENT SERVICE¶
The XML Processing Environment service is an original implementation that provides the support for processing xml document that could be accessed locally or remotely. In particular, the processing environment supports the XML include facility. XML content# create a document from a local file const xdoc ( afnix:xpe:XmlContent "file:///home/afnix/file.xml")When the uri scheme is a file, the uri authority is empty (hence the double //) and the path indicates the file to parse. The XmlContent object is derived from the XmlDocument object which contains the parsed tree with the XmlRoot object.
# create a document from a http connection const xdoc ( afnix:xpe:XmlContent "http://www.afnix.org/index.xht")When the uri scheme is a http scheme, the document is downloaded by establishing an http connection with the uri authority. When the http header is received, the content is parsed to create a valid xml document. If the http response header indicates that the page has moved and a new location is provided, the object manages automatically to follow such location. Content and document name
# create a document by name const xdoc (afnix:xpe:XmlContent "file" "file.xml")In the previous example, a xml content object is created by name with a document name. It is the document name that gets normalized. Therefore in the previous example, the file.xml document name is normalized into a file uri. The normalization rule always favor the file scheme. This means that without a scheme, the file scheme is automatically added. Content type
# create a new content by name and encoding mode const xdoc ( afnix:xpe:XmlContent "file" "file.xml" "UTF-8")
XML PROCESSING ENVIRONMENT SERVICE REFERENCE¶
XmlContentxml-content-p
Inheritance
XmlDocumentMime
Constructors
XmlContent (String)
The XmlContent constructor creates a xml document by name. The document name is
the normalized uri name that always favor a file scheme in the absence of
it.
XmlContent (String String)
The XmlContent constructor creates a xml document by name. The first argument is
the content name. The second argument is the document name which is normalized
to form the uri name used to load the document.
XmlContent (String String String)
The XmlContent constructor creates a xml document by name and encoding mode. The
first argument is the content name. The second argument is the document name
which is normalized to form the uri name used to load the document. The third
argument is the content character encoding.
Methods
get-document-uri -> String (none)
The get-document-uri method returns the document normalized uri.
get-document-name -> String (none)
The get-document-name method returns the object document name. This method
complements the get-name method which returns the object name.
XmlFeature
xhtml-feature-p
Inheritance
Nameable
Methods
get-info -> String (none)
The get-info method returns the xml feature information string. The feature name
is available from the get-name provided by the Nameable base class.
set-processing-level -> none (Integer)
The set-processing-level method sets the feature processing level. The integer
argument is the level to set.
get-processing-level -> Integer (none)
The get-processing-level method returns the feature processing level.
processing-level-p -> Boolean (Integer)
The processing-level-p predicate returns true if the integer argument equal the
feature processing level.
process -> XmlContent (XmlContent)
The process method process the input xml content and returns a new xml content.
The method is automatically called by the xml processor.
XmlProcessor
xml-processor-p
Inheritance
Object
Constructors
XmlProcessor (none)
The XmlProcessor constructor creates a default xml processor without any
feature.
Methods
feature-length -> Integer (none)
The feature-length method returns the number of features defined in the xml
processor.
add-feature -> none (XmlFeature)
The add-feature method adds a feature object to the processor. The feature
processing level does not have to be sorted prior the insertion. Adding
multiple feature creates a processor chain.
get-feature -> XmlFeature (Integer)
The get-feature method return a processor feature by index.
process -> XmlFeature (XmlFeature)
The process method create a new xml content by calling processing feature chain.
The feature chain consists of feature object sorted in ascending order. If the
processor contains only one feature, calling the process method is equivalent
to call the XmlFeature same method.
XmlInclude
xml-include-p
Inheritance
XmlFeature
Constructors
XmlInclude (none)
The XmlInclude constructor creates a default xml include feature. The default
feature processing level is 10.
XmlInclude (Integer)
The XmlInclude constructor creates a xml include feature with a processing
level. The integer argument is the feature processing level to set.
2012-03-26 | AFNIX |