|
header | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.xframe.xsddoc.Processor
The xsddoc processor.
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 |
public static final java.lang.String XSDDOC_PREFIX
public static final java.lang.String NAMESPACE_NAMESPACE
public static final java.lang.String XMLSCHEMA_NAMESPACE
public static final java.lang.String XSDDOC_NAMESPACE
public static final java.lang.String TARGETNAMESPACE
public static final java.lang.String NO_NAMESPACE
public static final java.lang.String RESOURCE_PROTOCOL
Constructor Detail |
public Processor()
Method Detail |
public void setHeader(java.lang.String theHeader)
theHeader
- the header to usepublic void setFooter(java.lang.String theFooter)
theFooter
- the footer to usepublic void setBottom(java.lang.String theBottom)
theBottom
- the bottom to usepublic void setDoctitle(java.lang.String theDoctitle)
theDoctitle
- schema title to usepublic void setSchemaLocation(java.lang.String theSchemaLocation)
theSchemaLocation
- location of XML schema to usepublic void setMainSchema(org.w3c.dom.Document document)
document
- DOM of main schemapublic void setOut(java.lang.String theOut)
theOut
- output folder to usepublic void setCss(java.lang.String theCss)
theCss
- output external CSS file to usepublic void setVerbose(boolean theVerbose)
theVerbose
- be verbose or notpublic void setDebug(boolean theDebug)
theDebug
- output debug information or notpublic boolean isDebug()
protected boolean isCreateFolder()
protected void setCreateFolder(boolean theCreateFolder)
theCreateFolder
- if output folder should be createdprotected boolean isLaunch()
protected void setLaunch(boolean theLaunch)
theLaunch
- if generated documentation should be launched after creationpublic void setXml(boolean theXml)
theXml
- if xml should be created or HTMLpublic void setHideLocalUsage(boolean theHideLocalUsage)
theHideLocalUsage
- if local usage should be hidden or notpublic void setHideSubTypes(boolean theHideSubTypes)
theHideSubTypes
- if sub types should be hidden or notpublic void setHideAttributes(boolean theHideAttributes)
theHideAttributes
- if attributes should be hidden or notpublic void setHideGroups(boolean theHideGroups)
theHideGroups
- if groups should be hidden or notpublic void setHideTypes(boolean theHideTypes)
theHideTypes
- if types should be hidden or notpublic void setProxyHost(java.lang.String theProxyHost)
theProxyHost
- The proxyHost to set.public void setProxyPort(java.lang.String theProxyPort)
theProxyPort
- The proxyPort to set.public ProcessorListener getListener()
public void setListener(ProcessorListener theListener)
theListener
- The listener to set.public void execute() throws ProcessorException
ProcessorException
- if error occured during executionpublic java.lang.String run()
This method can be used in batch processing to reuse an instance of this class for multiple operations.
|
header | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |