buldocs Ltd.
xnsdoc 1.2.1 Java API

com.xnsdoc
Class Processor

java.lang.Object
  extended bycom.xnsdoc.BaseProcessor
      extended bycom.xnsdoc.Processor

public final class Processor
extends BaseProcessor

The xnsdoc processor.


Nested Class Summary
 class Processor.MediatorSchema
          Collector for multiple schema file.
 
Field Summary
static java.lang.String VERSION
          version info.
 
Fields inherited from class com.xnsdoc.BaseProcessor
NAMESPACE_NAMESPACE, RESOURCE_PROTOCOL, SCHEMA_NS, XMLNS_XS, XMLSCHEMA_NAMESPACE
 
Constructor Summary
Processor()
          Default constructor.
 
Method Summary
 void addSchema(java.lang.String schemaLocation)
          Adds a schema defined by a file name to a mediator schema.
 void execute()
          Execution of the processor.
 java.lang.String run()
          Executes the processor and returns a string with all messages and exceptions that are normally sent to System.out.
 void setBottom(java.lang.String theBottom)
          Setter method for bottom property.
 void setCreateFolder(boolean theCreateFolder)
          Setter method for createFolder property.
 void setCss(java.lang.String theCss)
          Setter method for CSS property.
 void setDatatypes(boolean b)
          Setter method for datatypes property.
 void setDoctitle(java.lang.String theDoctitle)
          Setter method for title property.
 void setFooter(java.lang.String theFooter)
          Setter method for footer property.
 void setHeader(java.lang.String theHeader)
          Setter method for header property.
 void setHideAttributes(boolean theHideAttributes)
          Setter method for hideAttributes property.
 void setHideGroups(boolean theHideGroups)
          Setter method for hideGroups property.
 void setHideNotations(boolean theHideNotations)
          Setter method for hideNotations property.
 void setHideTypes(boolean theHideTypes)
          Setter method for hideTypes property.
 void setLaunch(boolean theLaunch)
          Setter method for launch property.
 void setLicense(java.lang.String theLicense)
          Setter method for license property.
 void setMainSchema(org.w3c.dom.Document document)
          Setter method for mainSchema property.
 void setMaxIdLength(int theMaxIdLength)
          Setter method for the maxIfLength propety.
 void setOut(java.lang.String theOut)
          Setter method for out property.
 void setProxyHost(java.lang.String theProxyHost)
          Setter method for proxyHost property.
 void setProxyPort(java.lang.String theProxyPort)
          Setter method for proxyPort property.
 void setSchemaLocation(java.lang.String theSchemaLocation)
          Setter method for schemaLocation property.
 void setXml(boolean theXml)
          Setter method for xml property.
 
Methods inherited from class com.xnsdoc.BaseProcessor
getListener, isDebug, isVerbose, setDebug, setListener, setVerbose
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERSION

public static final java.lang.String VERSION
version info.

Constructor Detail

Processor

public Processor()
Default constructor.

Method Detail

addSchema

public void addSchema(java.lang.String schemaLocation)
Adds a schema defined by a file name to a mediator schema.

Parameters:
schemaLocation - the schema to add

execute

public void execute()
             throws ProcessorException
Execution of the processor.

Throws:
ProcessorException - if error occured during execution

run

public java.lang.String run()
Executes the processor and returns a string with all messages and exceptions that are normally sent to System.out.

This method can be used in batch processing to reuse an instance of this class for multiple operations.

Returns:
String with all messages and exceptions

setBottom

public void setBottom(java.lang.String theBottom)
Setter method for bottom property. The bottom property can be either text or an HTML fragment. Usage: in the documentation at the end of each page below the bottom navigation.

Parameters:
theBottom - the bottom to use

setCreateFolder

public void setCreateFolder(boolean theCreateFolder)
Setter method for createFolder property. The CreateFolder property defines if the output folder should be created if it doesn't exist.

Parameters:
theCreateFolder - if output folder should be created

setCss

public void setCss(java.lang.String theCss)
Setter method for CSS property. The css property defines a file name of a CSS file that should be used to format the documentation.

Parameters:
theCss - output external CSS file to use

setDatatypes

public void setDatatypes(boolean b)
Setter method for datatypes property. The datatypes property defines if the built-in datatypes should be included in the generated documentation or not.

Parameters:
b - if XMLSchema datatypes should be included

setDoctitle

public void setDoctitle(java.lang.String theDoctitle)
Setter method for title property. The title property can be either text or an HTML fragment. Usage: in the documentation on the main page as page title and as header or footer if the header or footerproperty is empty.

Parameters:
theDoctitle - schema title to use

setFooter

public void setFooter(java.lang.String theFooter)
Setter method for footer property. The footer property can be either text or an HTML fragment. Usage: in the documentation on each page as descriptive text in the bottom navigation. If the footer property is empty, the doctitle property is used.

Parameters:
theFooter - the footer to use

setHeader

public void setHeader(java.lang.String theHeader)
Setter method for header property. The header property can be either text or an HTML fragment. Usage: in the documentation on each page as descriptive text in the top navigation. If the header property is empty, the doctile property is used.

Parameters:
theHeader - the header to use

setHideAttributes

public void setHideAttributes(boolean theHideAttributes)
Setter method for hideAttributes property.

Parameters:
theHideAttributes - if attributes should be hidden or not

setHideGroups

public void setHideGroups(boolean theHideGroups)
Setter method for hideGroups property.

Parameters:
theHideGroups - if groups should be hidden or not

setHideNotations

public void setHideNotations(boolean theHideNotations)
Setter method for hideNotations property.

Parameters:
theHideNotations - if types should be hidden or not

setHideTypes

public void setHideTypes(boolean theHideTypes)
Setter method for hideTypes property.

Parameters:
theHideTypes - if types should be hidden or not

setLaunch

public void setLaunch(boolean theLaunch)
Setter method for launch property. The launch property defines if the generated documentation should be launched in Browser after generation.

Parameters:
theLaunch - if generated documentation should be launched after creation

setLicense

public void setLicense(java.lang.String theLicense)
Setter method for license property.

Parameters:
theLicense - location of license file

setMainSchema

public void setMainSchema(org.w3c.dom.Document document)
Setter method for mainSchema property.

Parameters:
document - DOM of main schema

setMaxIdLength

public void setMaxIdLength(int theMaxIdLength)
Setter method for the maxIfLength propety.

The maxIdLength property defines the maximum length of id strings. Depending on the file system or later processing, a specific maximum length can ensure proper post-processing.

Parameters:
theMaxIdLength - The maxIdLength to set.

setOut

public void setOut(java.lang.String theOut)
Setter method for out property. The out property defines the output folder for the generated documentation.

Parameters:
theOut - output folder to use

setProxyHost

public void setProxyHost(java.lang.String theProxyHost)
Setter method for proxyHost property.

Parameters:
theProxyHost - The proxyHost to set.

setProxyPort

public void setProxyPort(java.lang.String theProxyPort)
Setter method for proxyPort property.

Parameters:
theProxyPort - The proxyPort to set.

setSchemaLocation

public void setSchemaLocation(java.lang.String theSchemaLocation)
Setter method for schemaLocation property. The schemaLocation property defines the location of the schema file to document, if only a single schema file should be documented.

Parameters:
theSchemaLocation - location of XML schema to use

setXml

public void setXml(boolean theXml)
Setter method for xml property. The xml property defines if the output should be XML instead of HTML.

Parameters:
theXml - if xml should be created or HTML

buldocs Ltd.
xnsdoc 1.2.1 Java API

Copyright 2005 buldocs Ltd. All rights reserved.
Use is subject to license terms.