de.frame4j

Class XMLio

java.lang.Object

de.frame4j.util.App

de.frame4j.XMLio

All Implemented Interfaces:

AttrSettable, TextHelper.MessageComponents, AppMBean, ComVar, UIInfo, ActionListener, EventListener

@MinDoc(copyright="Copyright 2001 - 2007, 2009, 2016  A. Weinert",
        author="Albrecht Weinert",
        version="V.44",
        lastModified="6.05.2021",
        usage="start as Java application (-? for help)",
        purpose="input [check] [validate] [transform] [and output | list] XML")
public class XMLio
extends App

XML input and output: XML —> DOM —> XML.

This application handles the input and output of XML documents as a DOM object. Multiple variants and combinations are possible:

• Input
  • Parse a text file or URL according to XML rules.
    The parser's strictness may be controlled in a wide range by properties (.properties files or command line parameters).
    This alone gives a quite good syntax check for all kinds of XML and (X)HTML files, by grace of clearly defined return codes suitable for automatic (batch) processing:
    return 2 or more: errors occurred (plus may be warnings)
    return 1 : only warnings (non fatal errors) occurred
    return 0 : all OK (parsed, optionally validated).
  • Read a serialised DOM object from a file or URL (option -deser). This will be done as serialised before without any checking / validating.
    Remark: After serialisation's migration (begun with JDK1.4 and here and in between performed) from binary to XML format de-serialising is just parsing (w/o validation).
• Transformation
  • Transforming the document (the DOM object) using a transforming XML style sheet (.xsl; option -trans).
  • Applying a standard transformation by XMLdoc.applyTransforms() (options -noDefAtts, -compact).
• Output
  • Output the document (the DOM object) as XML text to a file.
    The output formatting can be controlled by properties.
  • Output / Serialise the DOM object (the document) as is without all output formatting (option -ser).

The application handles the XML document as a object of type org.w3c.dom.Document.

For further pre or post processing by this or other applications objects of this type can be serialised respectively de-serialised by this application. In that sense this application may act as a common parser / reader / writer front respectively back end for any applications that handle / transform DOM objects without bothering of how to get or get rid off.

A .xsl style sheet transformation can be inserted before output.

Hint 1: To this application XMLio belongs (as integral part) a .properties file named XMLio.properties. It's part of the documentation.
See also the hints in the package description.

Hint 2: If the document to be parsed relates to DTDs (document type definitions) given as (web) URLs, like e.g.
"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
they will be loaded while parsing.

Besides the possible performance impact, this may require proxy settings. They can comfortably put in a .properties file.


© Copyright 2001 - 2003, 2007 Albrecht Weinert

Version:

44 (6.05.2021)

Author:

Albrecht Weinert

See Also:

App, Input, XMLconf, SAXdemo

Nested Class Summary

Nested classes/interfaces inherited from interface de.frame4j.util.ComVar

ComVar.Impl

Field Summary

Fields

Modifier and Type	Field and Description
String	dest The destination file's name or the denotation of a destination directory.
boolean	parse Do a XML parsing instead of de-serialising.
boolean	serialise Serialise the DOM object on output instead of outputting XML text.
String	source The source file's name or the source URL denomination.
int	structList List the DOM object's structure.
String	trans An XSL transformation file's name or URL.

Fields inherited from class de.frame4j.util.App

ano, appBase, appIO, appStartTime, appStartTimeMS, args, argsOrig, bgColor, err, fullClassName, help, icon, log, mainThread, myClass, myFrame, name, out, outMode, packName, prop, retCode, runFlag, shortClassName, title, verbose, verbosity

Fields inherited from interface de.frame4j.util.ComVar

AUTHOR, BLANK_STRING, cons, CONSOL_ENCODING, COPYRIGHT, D, D_NaN, D_NegInf, D_PosInf, EMPTY_INT_A, EMPTY_STRING, FILE_ENCODING, FRW_CLLD, FS, FSS, H, hasCons, HOST_IP, HOST_IPv4, HOST_NAME, INIT_ERROR, JAR_ENCODING, JH, JOB_DONE_OK, JRL, LOG_OUT_ERROR, M, MAIN_THREAD_EXC, NO_BYTES, NO_CLASSES, NO_DOUBLES, NO_OBJECTS, NO_PARS_ERROR, NO_STRINGS, NOT_WINDOWS, ON_PI, ONE_DAY, ONE_HOUR, ONE_LEAP_YEAR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, ONE_YEAR, OS, PROG_NAME, PROG_SHORT, PS, RUNTIME, S, SHY, UD, UL, UL_UR_da, UR

Fields inherited from interface de.frame4j.net.AttrSettable

ILLEGAL_TYPE, ILLEGAL_VALUE, NO_ATTRIBUTE, NO_KNOWN_ATTRIBUTE, NO_VALUE, OK, retVtext

Method Summary

Modifier and Type	Method and Description
int	doIt() Working method of XMLio.
static void	main(String[] args) Start method of XMLio.

Methods inherited from class de.frame4j.util.App

actionPerformed, allowNoPropertiesFile, clientOrder, condHelpLog, connect, errMeld, errMeld, errorExit, errorExit, errorText, extraPropertiesFile, formMessage, formMessage, formMessage, getAbout, getAboutText, getActTime, getAppLogger, getAppStartTime, getArgs, getAuthor, getCopyright, getDbLogger, getExecTimeMs, getExecTimeMsL, getExecTimeString, getHelp, getHelpText, getIcon, getLanguage, getLogHandler, getMessageComponent, getMessageComponentsLength, getMyFrame, getName, getNameWithVersDate, getOutMode, getProp, getPurpose, getStartTime, getStateString, getTheCloser, getTitle, getUsage, getVerbose, getVerbosity, getVersDate, go, go, go, haveIcon, isDebug, isHelp, isHelpLog, isNormal, isRunFlag, isSilent, isTest, isVerbose, logVerbose, logVerbose, makeStatusTextEnd, makeStatusTextStart, messageFormat, normalExit, parsePartial, performeAction, queueAction, regAsStdMBean, repExc, setAboutText, setAttribute, setAttribute, setAuthor, setBgColor, setCodePages, setCopyright, setHelp, setLogOut2, setName, setOutMode, setOutMode, setPurpose, setTitle, setUsage, setVerbose, setVerbose, setVerbosity, setVerbosity, setVersDate, stop, threeLineEndMsg, toString, twoLineEndMsg, twoLineStartMsg, valueLang, valueLang, wakeMainThread

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.frame4j.net.AttrSettable

retVtext

Field Detail

source

public String source

The source file's name or the source URL denomination.

The content must either be parsable XML text or a serialised DOM depending on start options.

default: null (means normal input; as keyboard it makes usually no sense.)

dest

public String dest

The destination file's name or the denotation of a destination directory.

dest may be a file or a directory. A directory makes sense only if source denotes an input file. In that case name.ser respectively name.out is taken as output file name in the destination directory.

default: null; null means normal output (usually makes no sense)

trans

public String trans

An XSL transformation file's name or URL.

This names a eXtensible StyLe sheet responsible for transforming the document prior to output.

default: null; null means no style sheet transformation

parse

public boolean parse

Do a XML parsing instead of de-serialising.

true is the normal case and the default.

serialise

public boolean serialise

Serialise the DOM object on output instead of outputting XML text.

If true the DOM object is output without formatting and transformations. That is as well a XML text.

default: true

structList

public int structList

List the DOM object's structure.

If > 0 the DOM's structure will be listed on output down to the tree depth / recursion level indicated by structList's value.

Has precedence before serialise.

default: 0

Method Detail

main

public static void main(String[] args)

Start method of XMLio.

Execute : Java XMLio [options] source dest

Exit code 0: All OK no errors or warnings
Exit code 1: Warnings or non fatal errors occurred; the result may nevertheless be usable
Exit code 2 or higher: Fatal errors occurred or application or I/O failure

Parameters:

args - command line parameter

doIt

public int doIt()

Working method of XMLio.

Specified by:

doIt in class App

Returns:

the exit code; 0 means OK

See Also:

main(String[]), App.go(java.lang.String[], java.lang.String, java.lang.CharSequence)