header

net.sf.xframe.xsddoc
Class Processor

java.lang.Object
  extended bynet.sf.xframe.xsddoc.Processor

public final class Processor
extends java.lang.Object

The xsddoc processor.

Author:
Kurt Riede

Nested Class Summary
 class Processor.ConsoleListener
          Implementation of the ProcessorListener interface that simple logs everything to the console.
 
Field Summary
static java.lang.String NAMESPACE_NAMESPACE
          Namespace-URI of namespace of W3C-XML-Namespace.
static java.lang.String NO_NAMESPACE
          Folder name for components that do not belong to a namespace.
static java.lang.String RESOURCE_PROTOCOL
          protocol prefix for resource files.
static java.lang.String TARGETNAMESPACE
          Attribute name: targetNamespace.
static java.lang.String XMLSCHEMA_NAMESPACE
          Namespace-URI of namespace of W3C-XML-Schema.
static java.lang.String XSDDOC_NAMESPACE
          Namespace-URI of namespace of xsddoc.
static java.lang.String XSDDOC_PREFIX
          Unique prefix for xsddoc attributes.
 
Constructor Summary
Processor()
          Default constructor.
 
Method Summary
 void execute()
          Executes xsddoc.
 ProcessorListener getListener()
          Getter method for listener property.
protected  boolean isCreateFolder()
          Getter method for createFolder property.
 boolean isDebug()
          Getter method for debug property.
protected  boolean isLaunch()
          Getter method for launch property.
 java.lang.String run()
          Executes xsddoc 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.
protected  void setCreateFolder(boolean theCreateFolder)
          Setter method for createFolder property.
 void setCss(java.lang.String theCss)
          Setter method for CSS property.
 void setDebug(boolean theDebug)
          Setter method for debug 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 setHideLocalUsage(boolean theHideLocalUsage)
          Setter method for hideLocalUsage property.
 void setHideSubTypes(boolean theHideSubTypes)
          Setter method for hideSubTypes property.
 void setHideTypes(boolean theHideTypes)
          Setter method for hideTypes property.
protected  void setLaunch(boolean theLaunch)
          Setter method for launch property.
 void setListener(ProcessorListener theListener)
          Setter method for the listener.
 void setMainSchema(org.w3c.dom.Document document)
          Setter method for mainSchema property.
 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 setVerbose(boolean theVerbose)
          Setter method for verbose property.
 void setXml(boolean theXml)
          Setter method for xml property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XSDDOC_PREFIX

public static final java.lang.String XSDDOC_PREFIX
Unique prefix for xsddoc attributes.

See Also:
Constant Field Values

NAMESPACE_NAMESPACE

public static final java.lang.String NAMESPACE_NAMESPACE
Namespace-URI of namespace of W3C-XML-Namespace.

See Also:
Constant Field Values

XMLSCHEMA_NAMESPACE

public static final java.lang.String XMLSCHEMA_NAMESPACE
Namespace-URI of namespace of W3C-XML-Schema.

See Also:
Constant Field Values

XSDDOC_NAMESPACE

public static final java.lang.String XSDDOC_NAMESPACE
Namespace-URI of namespace of xsddoc.

See Also:
Constant Field Values

TARGETNAMESPACE

public static final java.lang.String TARGETNAMESPACE
Attribute name: targetNamespace.

See Also:
Constant Field Values

NO_NAMESPACE

public static final java.lang.String NO_NAMESPACE
Folder name for components that do not belong to a namespace.

See Also:
Constant Field Values

RESOURCE_PROTOCOL

public static final java.lang.String RESOURCE_PROTOCOL
protocol prefix for resource files.

See Also:
Constant Field Values
Constructor Detail

Processor

public Processor()
Default constructor.

Method Detail

setHeader

public void setHeader(java.lang.String theHeader)
Setter method for header property.

Parameters:
theHeader - the header to use

setFooter

public void setFooter(java.lang.String theFooter)
Setter method for footer property.

Parameters:
theFooter - the footer to use

setBottom

public void setBottom(java.lang.String theBottom)
Setter method for bottom property.

Parameters:
theBottom - the bottom to use

setDoctitle

public void setDoctitle(java.lang.String theDoctitle)
Setter method for title property.

Parameters:
theDoctitle - schema title to use

setSchemaLocation

public void setSchemaLocation(java.lang.String theSchemaLocation)
Setter method for schemaLocation property.

Parameters:
theSchemaLocation - location of XML schema to use

setMainSchema

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

Parameters:
document - DOM of main schema

setOut

public void setOut(java.lang.String theOut)
Setter method for out property.

Parameters:
theOut - output folder to use

setCss

public void setCss(java.lang.String theCss)
Setter method for CSS property.

Parameters:
theCss - output external CSS file to use

setVerbose

public void setVerbose(boolean theVerbose)
Setter method for verbose property.

Parameters:
theVerbose - be verbose or not

setDebug

public void setDebug(boolean theDebug)
Setter method for debug property.

Parameters:
theDebug - output debug information or not

isDebug

public boolean isDebug()
Getter method for debug property.

Returns:
if debug mode enabled or not

isCreateFolder

protected boolean isCreateFolder()
Getter method for createFolder property.

Returns:
if output folder should be created

setCreateFolder

protected void setCreateFolder(boolean theCreateFolder)
Setter method for createFolder property.

Parameters:
theCreateFolder - if output folder should be created

isLaunch

protected boolean isLaunch()
Getter method for launch property.

Returns:
if generated documentation should be launched after creation

setLaunch

protected void setLaunch(boolean theLaunch)
Setter method for launch property.

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

setXml

public void setXml(boolean theXml)
Setter method for xml property.

Parameters:
theXml - if xml should be created or HTML

setHideLocalUsage

public void setHideLocalUsage(boolean theHideLocalUsage)
Setter method for hideLocalUsage property.

Parameters:
theHideLocalUsage - if local usage should be hidden or not

setHideSubTypes

public void setHideSubTypes(boolean theHideSubTypes)
Setter method for hideSubTypes property.

Parameters:
theHideSubTypes - if sub types should be hidden or not

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

setHideTypes

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

Parameters:
theHideTypes - if types should be hidden or not

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.

getListener

public ProcessorListener getListener()
Getter method for listener property.

Returns:
Returns the listener.

setListener

public void setListener(ProcessorListener theListener)
Setter method for the listener.

Parameters:
theListener - The listener to set.

execute

public void execute()
             throws ProcessorException
Executes xsddoc.

Throws:
ProcessorException - if error occured during execution

run

public java.lang.String run()
Executes xsddoc 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

header

Submit a bug or a feature.
Created by xsddoc, a sub project of xframe, hosted at http://www.sourceforge.net.