xdoclet

Class XmlSubTask

public class XmlSubTask extends TemplateSubTask

Generic subtask for processing a user-supplied template, to generate an XML document.

Version: $Revision: 1.25 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Oct 13, 2001 name = "xml" parent = "xdoclet.DocletTask" display-name = "Standard Subtask for XML generation"

Method Summary
voidcopyAttributesFrom(TemplateSubTask templateSrc)
Describe what the method does
protected voidengineFinished()
Describe what the method does
URLgetDtdURL()
Gets the DtdURL attribute of the XmlSubTask object.
StringgetPublicId()
Gets the PublicId attribute of the XmlSubTask object.
StringgetSchema()
Gets the Schema attribute of the XmlSubTask object.
URLgetSchemaURL()
Gets the SchemaURL attribute of the XmlSubTask object.
StringgetSystemId()
Gets the SystemId attribute of the XmlSubTask object.
booleangetUseIds()
Gets the UseIds attribute of the XmlSubTask object.
StringgetXmlencoding()
Gets the Xmlencoding attribute of the XmlSubTask object.
booleanisValidateXML()
Gets the ValidateXML attribute of the XmlSubTask object.
protected voidsetDtdURL(URL dtdURL)
Sets the DtdURL attribute of the XmlSubTask object.
protected voidsetPublicId(String publicId)
The PUBLIC ID of the DTD to which the generated document should conform.
voidsetSchema(String schema)
The XML Schema to which the generated document should conform.
protected voidsetSchemaURL(URL url)
Sets the SchemaURL attribute of the XmlSubTask object.
protected voidsetSystemId(String systemId)
The SYSTEM ID of the DTD to which the generated document should conform.
voidsetUseIds(boolean useIds)
If this attribute is set to true, XDoclet will generate id attributes in the XML document.
voidsetValidateXML(boolean flag)
If this is set to true, the generated XML will be validated against its DTD or XML Schema.
voidsetXmlencoding(String xmlEncoding)
The encoding of the produced xml file.
voidstartProcess()
Describe what the method does

Method Detail

copyAttributesFrom

public void copyAttributesFrom(TemplateSubTask templateSrc)
Describe what the method does

Parameters: templateSrc Describe what the parameter does

engineFinished

protected void engineFinished()
Describe what the method does

Throws: XDocletException Describe the exception

getDtdURL

public URL getDtdURL()
Gets the DtdURL attribute of the XmlSubTask object.

Returns: The DtdURL value

getPublicId

public String getPublicId()
Gets the PublicId attribute of the XmlSubTask object.

Returns: The PublicId value

getSchema

public String getSchema()
Gets the Schema attribute of the XmlSubTask object.

Returns: The Schema value

getSchemaURL

public URL getSchemaURL()
Gets the SchemaURL attribute of the XmlSubTask object.

Returns: The SchemaURL value

getSystemId

public String getSystemId()
Gets the SystemId attribute of the XmlSubTask object.

Returns: The SystemId value

getUseIds

public boolean getUseIds()
Gets the UseIds attribute of the XmlSubTask object.

Returns: The UseIds value

getXmlencoding

public String getXmlencoding()
Gets the Xmlencoding attribute of the XmlSubTask object.

Returns: The Xmlencoding value

isValidateXML

public boolean isValidateXML()
Gets the ValidateXML attribute of the XmlSubTask object.

Returns: The ValidateXML value

setDtdURL

protected void setDtdURL(URL dtdURL)
Sets the DtdURL attribute of the XmlSubTask object.

Parameters: dtdURL The new DtdURL value

setPublicId

protected void setPublicId(String publicId)
The PUBLIC ID of the DTD to which the generated document should conform.

Parameters: publicId The new PublicId value

setSchema

public void setSchema(String schema)
The XML Schema to which the generated document should conform.

Parameters: schema The new Schema value

setSchemaURL

protected void setSchemaURL(URL url)
Sets the SchemaURL attribute of the XmlSubTask object.

Parameters: url The new SchemaURL value

setSystemId

protected void setSystemId(String systemId)
The SYSTEM ID of the DTD to which the generated document should conform.

Parameters: systemId The new SystemId value

setUseIds

public void setUseIds(boolean useIds)
If this attribute is set to true, XDoclet will generate id attributes in the XML document. Note that this is only available in some subtasks.

Parameters: useIds The new UseIds value

UNKNOWN: "No. Default is 'false'"

setValidateXML

public void setValidateXML(boolean flag)
If this is set to true, the generated XML will be validated against its DTD or XML Schema.

Parameters: flag The new Validatexml value

UNKNOWN: No,defaultis false.

setXmlencoding

public void setXmlencoding(String xmlEncoding)
The encoding of the produced xml file. If your XML file uses international characters, you might want to set this to "ISO-8859-1".

Parameters: xmlEncoding The new Xmlencoding value

UNKNOWN: "No, default is 'UTF-8'"

startProcess

public void startProcess()
Describe what the method does

Throws: XDocletException Describe the exception