Package com.altova.automation.XMLSpy

Class Document

java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

com.altova.automation.XMLSpy.Document

public class Document
extends COMIDispatchObject

Field Summary

Fields inherited from class com.altova.automation.libs.COMIDispatchObject

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Method Summary

Modifier and Type	Method	Description
void	assignDTD(java.lang.String strDTDFile, boolean bDialog)	method AssignDTD
void	assignSchema(java.lang.String strSchemaFile, boolean bDialog)	method AssignSchema
void	assignXSL(java.lang.String strXSLFile, boolean bDialog)	method AssignXSL
void	assignXSLFO(java.lang.String i_strFileName, boolean i_bDialog)	method AssignXSLFO
void	close(boolean bDiscardChanges)	method Close
void	convertDTDOrSchema(Enums.SPYDTDSchemaFormat nFormat, Enums.SPYFrequentElements nFrequentElements)	method ConvertDTDOrSchema
Document	convertDTDOrSchemaEx(Enums.SPYDTDSchemaFormat nFormat, Enums.SPYFrequentElements nFrequentElements, java.lang.String sOutputPath, Enums.SPYDialogAction nOutputPathDialogAction)	method ConvertDTDOrSchemaEx
Document	convertToWSDL20(java.lang.String sFilePath, boolean bShowDialogs)	Convert WSDL 1.1 document to 2.0
Document	convertXMLToFromJSON()	Converts XML files to JSON and JSON files to XML.
XMLData	createChild(Enums.SPYXMLDataKind nKind)	method CreateChild
java.lang.String	createDBStructureFromXMLSchema(DatabaseConnection pDatabase, JVariant tables, boolean bDropTableWithExistingName)	Creates DB structures from a given XML Schema.
void	createSchemaDiagram(Enums.SPYSchemaDefKind nKind, java.lang.String strName, java.lang.String strFile)	method CreateSchemaDiagram
void	endChanges()	method EndChanges
void	executeXQuery(java.lang.String i_strXMLSourceFile)	method ExecuteXQuery
void	exportToDatabase(XMLData pFromChild, ExportSettings pExportSettings, DatabaseConnection pDatabase)	method ExportToDatabase
void	exportToText(XMLData pFromChild, ExportSettings pExportSettings, TextImportExportSettings pTextSettings)	method ExportToDatabase
Document	flattenDTDOrSchema(java.lang.String sOutputPath, Enums.SPYDialogAction nOutputPathDialogAction)	method FlattenDTDOrSchema
void	generateDTDOrSchema(Enums.SPYDTDSchemaFormat nFormat, short nValuesList, Enums.SPYTypeDetection nDetection, Enums.SPYFrequentElements nFrequentElements)	method GenerateDTDOrSchema
Document	generateDTDOrSchemaEx(DTDSchemaGeneratorDlg ipDTDSchemaGeneratorDlg)	method GenerateDTDOrSchemaEx
void	generateJSONSchemaDocumentation(JSONSchemaDocumentationDlg i_ipDlg)	method GenerateJSONSchemaDocumentation
void	generateProgramCode(CodeGeneratorDlg i_ipDlg)	method GenerateProgramCode
Document	generateSampleXML(GenerateSampleXMLDlg ipGenerateXMLDlg)	Generates a sample ML based if the document is a schema or DTD.
void	generateSchemaDocumentation(SchemaDocumentationDlg i_ipDlg)	method GenerateSchemaDocumentation
void	generateWSDL20Documentation(WSDL20DocumentationDlg pDialog)	Generates WSDL 2.0 documentation.
void	generateWSDLDocumentation(WSDLDocumentationDlg pDialog)	Generates WSDL documentation.
void	generateXBRLDocumentation(XBRLDocumentationDlg pDialog)	Generates XBRL documentation.
COMIDispatchObject	getApplication()	property Application
java.lang.String	getAsXMLString()	property AsXMLString
AuthenticView	getAuthenticView()	property AuthenticView
Enums.SPYViewModes	getCurrentViewMode()	property ActiveViewMode
XMLData	getDataRoot()	property DataRoot
ElementList	getDBStructureList(DatabaseConnection pDatabase)	Returns the list of tables that can be created from the current Schema.
OldAuthenticView	getDocEditView()	property DocEditView
java.lang.String	getEncoding()	property Encoding
GUID	getEventInterfaceIID()
ElementList	getExportElementList(XMLData pFromChild, ExportSettings pExportSettings)	method GetExportElementList
java.lang.String	getFullName()	property FullName
GridView	getGridView()	property GridView
GUID	getInterfaceIID()
boolean	getIsModified()	property IsModified
java.lang.String	getName()	property Name
COMIDispatchObject	getParent()	property Parent
java.lang.String	getPath()	property Path
java.lang.String	getPathName()	method GetPathName
XMLData	getRootElement()	property RootElement
boolean	getSaved()	property Saved
JVariant	getSuggestions()	Returnssets a value containing the suggestion window content.
TextView	getTextView()	Returns a TextView object when the current view mode is 'spyViewText'.
java.lang.String	getTitle()	property Title
boolean	getTreatXBRLInconsistenciesAsErrors()	Let IsValid() treat XBRL inconsistencies as errors
boolean	isValid(JVariant strError, JVariant nErrorPos, JVariant pBadData)	method IsValid
boolean	isValidEx(Enums.SPYValidateXSDVersion nXSDVersion, int nErrorLimit, Enums.SPYValidateErrorFormat nErrorFormat, JVariant strError)	method IsValidEx
boolean	isWellFormed(XMLData pData, boolean bWithChildren, JVariant strError, JVariant nErrorPos, JVariant pBadXMLData)	method IsWellFormed
void	save()	method Save
void	saveAs(java.lang.String i_strFileNameOrPath)	method SaveAs
java.lang.String	saveInString(XMLData pData, boolean bMarked)	method SaveInString
void	saveToURL(java.lang.String strURL, java.lang.String strUser, java.lang.String strPassword)	method SaveToURL
void	setActiveDocument()	method SetActiveDocument
void	setAsXMLString(java.lang.String newValue)	property AsXMLString
void	setEncoding(java.lang.String newValue)	property Encoding
void	setExternalIsValid(boolean bIsValid)	The internal information set by this method is only queried on cancelling the default validation in any OnBeforeValidate handler.
void	setFileEncoding(java.lang.String strEncoding)	method SetEncoding
void	setFullName(java.lang.String newValue)	property FullName
void	setPathName(java.lang.String strPath)	method SetPathName
void	setSelection(java.lang.String newValue)	Sets the current selection in the document.
void	setSuggestions(JVariant newValue)	Returnssets a value containing the suggestion window content.
void	setTreatXBRLInconsistenciesAsErrors(boolean newValue)	Let IsValid() treat XBRL inconsistencies as errors
void	startChanges()	method StartChanges
boolean	switchViewMode(Enums.SPYViewModes nMode)	method SwitchViewMode
void	transformXSL()	method TransformXSL
void	transformXSLEx(Enums.SPYDialogAction nAction)	Performs XSL transformation.
void	transformXSLFO()	method TransformXSLFO
void	transformXSLFOEx(Enums.SPYDialogAction nAction, java.lang.String sOutputFilepath)	Performs XSLFO transformation.
void	updateViews()	method UpdateViews
boolean	updateXMLData()	The XMLData tree is updated from the current view.
boolean	validateOnServer(Enums.SPYValidateErrorFormat nErrorFormat, JVariant strError)	method ValidateOnServer - restricted access

Methods inherited from class com.altova.automation.libs.COMIDispatchObject

addListener, getProperty, getProperty, invoke, removeListener, setProperty, setProperty

Methods inherited from class com.altova.automation.libs.COMIUnknownObject

dispose, equals, getCOMInterfacePointer, isNull

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInterfaceIID

public GUID getInterfaceIID()

getEventInterfaceIID

public GUID getEventInterfaceIID()

getTitle

public java.lang.String getTitle() throws AutomationException

property Title

Throws:

AutomationException

close

public void close(boolean bDiscardChanges) throws AutomationException

method Close

Throws:

AutomationException

save

public void save() throws AutomationException

method Save

Throws:

AutomationException

getRootElement

public XMLData getRootElement() throws AutomationException

property RootElement

Throws:

AutomationException

createChild

public XMLData createChild(Enums.SPYXMLDataKind nKind) throws AutomationException

method CreateChild

Throws:

AutomationException

updateViews

public void updateViews() throws AutomationException

method UpdateViews

Throws:

AutomationException

isWellFormed

public boolean isWellFormed(XMLData pData, boolean bWithChildren, JVariant strError, JVariant nErrorPos, JVariant pBadXMLData) throws AutomationException

method IsWellFormed

Throws:

AutomationException

isValid

public boolean isValid(JVariant strError, JVariant nErrorPos, JVariant pBadData) throws AutomationException

method IsValid

Throws:

AutomationException

assignDTD

public void assignDTD(java.lang.String strDTDFile, boolean bDialog) throws AutomationException

method AssignDTD

Throws:

AutomationException

saveInString

public java.lang.String saveInString(XMLData pData, boolean bMarked) throws AutomationException

method SaveInString

Throws:

AutomationException

generateDTDOrSchema

public void generateDTDOrSchema(Enums.SPYDTDSchemaFormat nFormat, short nValuesList, Enums.SPYTypeDetection nDetection, Enums.SPYFrequentElements nFrequentElements) throws AutomationException

method GenerateDTDOrSchema

Throws:

AutomationException

setPathName

public void setPathName(java.lang.String strPath) throws AutomationException

method SetPathName

Throws:

AutomationException

getGridView

public GridView getGridView() throws AutomationException

property GridView

Throws:

AutomationException

startChanges

public void startChanges() throws AutomationException

method StartChanges

Throws:

AutomationException

endChanges

public void endChanges() throws AutomationException

method EndChanges

Throws:

AutomationException

setFileEncoding

public void setFileEncoding(java.lang.String strEncoding) throws AutomationException

method SetEncoding

Throws:

AutomationException

setActiveDocument

public void setActiveDocument() throws AutomationException

method SetActiveDocument

Throws:

AutomationException

exportToDatabase

public void exportToDatabase(XMLData pFromChild, ExportSettings pExportSettings, DatabaseConnection pDatabase) throws AutomationException

method ExportToDatabase

Throws:

AutomationException

exportToText

public void exportToText(XMLData pFromChild, ExportSettings pExportSettings, TextImportExportSettings pTextSettings) throws AutomationException

method ExportToDatabase

Throws:

AutomationException

getExportElementList

public ElementList getExportElementList(XMLData pFromChild, ExportSettings pExportSettings) throws AutomationException

method GetExportElementList

Throws:

AutomationException

transformXSL

public void transformXSL() throws AutomationException

method TransformXSL

Throws:

AutomationException

assignXSL

public void assignXSL(java.lang.String strXSLFile, boolean bDialog) throws AutomationException

method AssignXSL

Throws:

AutomationException

convertDTDOrSchema

public void convertDTDOrSchema(Enums.SPYDTDSchemaFormat nFormat, Enums.SPYFrequentElements nFrequentElements) throws AutomationException

method ConvertDTDOrSchema

Throws:

AutomationException

assignSchema

public void assignSchema(java.lang.String strSchemaFile, boolean bDialog) throws AutomationException

method AssignSchema

Throws:

AutomationException

saveToURL

public void saveToURL(java.lang.String strURL, java.lang.String strUser, java.lang.String strPassword) throws AutomationException

method SaveToURL

Throws:

AutomationException

createSchemaDiagram

public void createSchemaDiagram(Enums.SPYSchemaDefKind nKind, java.lang.String strName, java.lang.String strFile) throws AutomationException

method CreateSchemaDiagram

Throws:

AutomationException

switchViewMode

public boolean switchViewMode(Enums.SPYViewModes nMode) throws AutomationException

method SwitchViewMode

Throws:

AutomationException

getPathName

public java.lang.String getPathName() throws AutomationException

method GetPathName

Throws:

AutomationException

getCurrentViewMode

public Enums.SPYViewModes getCurrentViewMode() throws AutomationException

property ActiveViewMode

Throws:

AutomationException

getDocEditView

public OldAuthenticView getDocEditView() throws AutomationException

property DocEditView

Throws:

AutomationException

getIsModified

public boolean getIsModified() throws AutomationException

property IsModified

Throws:

AutomationException

getAuthenticView

public AuthenticView getAuthenticView() throws AutomationException

property AuthenticView

Throws:

AutomationException

getApplication

public COMIDispatchObject getApplication() throws AutomationException

property Application

Throws:

AutomationException

getParent

public COMIDispatchObject getParent() throws AutomationException

property Parent

Throws:

AutomationException

getFullName

public java.lang.String getFullName() throws AutomationException

property FullName

Throws:

AutomationException

setFullName

public void setFullName(java.lang.String newValue) throws AutomationException

property FullName

Throws:

AutomationException

getName

public java.lang.String getName() throws AutomationException

property Name

Throws:

AutomationException

getPath

public java.lang.String getPath() throws AutomationException

property Path

Throws:

AutomationException

getSaved

public boolean getSaved() throws AutomationException

property Saved

Throws:

AutomationException

saveAs

public void saveAs(java.lang.String i_strFileNameOrPath) throws AutomationException

method SaveAs

Throws:

AutomationException

getEncoding

public java.lang.String getEncoding() throws AutomationException

property Encoding

Throws:

AutomationException

setEncoding

public void setEncoding(java.lang.String newValue) throws AutomationException

property Encoding

Throws:

AutomationException

getDataRoot

public XMLData getDataRoot() throws AutomationException

property DataRoot

Throws:

AutomationException

generateProgramCode

public void generateProgramCode(CodeGeneratorDlg i_ipDlg) throws AutomationException

method GenerateProgramCode

Throws:

AutomationException

assignXSLFO

public void assignXSLFO(java.lang.String i_strFileName, boolean i_bDialog) throws AutomationException

method AssignXSLFO

Throws:

AutomationException

transformXSLFO

public void transformXSLFO() throws AutomationException

method TransformXSLFO

Throws:

AutomationException

generateSchemaDocumentation

public void generateSchemaDocumentation(SchemaDocumentationDlg i_ipDlg) throws AutomationException

method GenerateSchemaDocumentation

Throws:

AutomationException

executeXQuery

public void executeXQuery(java.lang.String i_strXMLSourceFile) throws AutomationException

method ExecuteXQuery

Throws:

AutomationException

setExternalIsValid

public void setExternalIsValid(boolean bIsValid) throws AutomationException

The internal information set by this method is only queried on cancelling the default validation in any OnBeforeValidate handler.

Throws:

AutomationException

generateSampleXML

public Document generateSampleXML(GenerateSampleXMLDlg ipGenerateXMLDlg) throws AutomationException

Generates a sample ML based if the document is a schema or DTD.

Throws:

AutomationException

updateXMLData

public boolean updateXMLData() throws AutomationException

The XMLData tree is updated from the current view.

Throws:

AutomationException

getAsXMLString

public java.lang.String getAsXMLString() throws AutomationException

property AsXMLString

Throws:

AutomationException

setAsXMLString

public void setAsXMLString(java.lang.String newValue) throws AutomationException

property AsXMLString

Throws:

AutomationException

generateDTDOrSchemaEx

public Document generateDTDOrSchemaEx(DTDSchemaGeneratorDlg ipDTDSchemaGeneratorDlg) throws AutomationException

method GenerateDTDOrSchemaEx

Throws:

AutomationException

convertDTDOrSchemaEx

public Document convertDTDOrSchemaEx(Enums.SPYDTDSchemaFormat nFormat, Enums.SPYFrequentElements nFrequentElements, java.lang.String sOutputPath, Enums.SPYDialogAction nOutputPathDialogAction) throws AutomationException

method ConvertDTDOrSchemaEx

Throws:

AutomationException

getTextView

public TextView getTextView() throws AutomationException

Returns a TextView object when the current view mode is 'spyViewText'.

Throws:

AutomationException

getSuggestions

public JVariant getSuggestions() throws AutomationException

Returnssets a value containing the suggestion window content.

Throws:

AutomationException

setSuggestions

public void setSuggestions(JVariant newValue) throws AutomationException

Returnssets a value containing the suggestion window content.

Throws:

AutomationException

setSelection

public void setSelection(java.lang.String newValue) throws AutomationException

Sets the current selection in the document.

Throws:

AutomationException

generateWSDLDocumentation

public void generateWSDLDocumentation(WSDLDocumentationDlg pDialog) throws AutomationException

Generates WSDL documentation.

Throws:

AutomationException

transformXSLEx

public void transformXSLEx(Enums.SPYDialogAction nAction) throws AutomationException

Performs XSL transformation.

Throws:

AutomationException

generateWSDL20Documentation

public void generateWSDL20Documentation(WSDL20DocumentationDlg pDialog) throws AutomationException

Generates WSDL 2.0 documentation.

Throws:

AutomationException

generateXBRLDocumentation

public void generateXBRLDocumentation(XBRLDocumentationDlg pDialog) throws AutomationException

Generates XBRL documentation.

Throws:

AutomationException

convertToWSDL20

public Document convertToWSDL20(java.lang.String sFilePath, boolean bShowDialogs) throws AutomationException

Convert WSDL 1.1 document to 2.0

Throws:

AutomationException

getTreatXBRLInconsistenciesAsErrors

public boolean getTreatXBRLInconsistenciesAsErrors() throws AutomationException

Let IsValid() treat XBRL inconsistencies as errors

Throws:

AutomationException

setTreatXBRLInconsistenciesAsErrors

public void setTreatXBRLInconsistenciesAsErrors(boolean newValue) throws AutomationException

Let IsValid() treat XBRL inconsistencies as errors

Throws:

AutomationException

convertXMLToFromJSON

public Document convertXMLToFromJSON() throws AutomationException

Converts XML files to JSON and JSON files to XML.

Throws:

AutomationException

createDBStructureFromXMLSchema

public java.lang.String createDBStructureFromXMLSchema(DatabaseConnection pDatabase, JVariant tables, boolean bDropTableWithExistingName) throws AutomationException

Creates DB structures from a given XML Schema.

Throws:

AutomationException

getDBStructureList

public ElementList getDBStructureList(DatabaseConnection pDatabase) throws AutomationException

Returns the list of tables that can be created from the current Schema.

Throws:

AutomationException

transformXSLFOEx

public void transformXSLFOEx(Enums.SPYDialogAction nAction, java.lang.String sOutputFilepath) throws AutomationException

Performs XSLFO transformation.

Throws:

AutomationException

flattenDTDOrSchema

public Document flattenDTDOrSchema(java.lang.String sOutputPath, Enums.SPYDialogAction nOutputPathDialogAction) throws AutomationException

method FlattenDTDOrSchema

Throws:

AutomationException

isValidEx

public boolean isValidEx(Enums.SPYValidateXSDVersion nXSDVersion, int nErrorLimit, Enums.SPYValidateErrorFormat nErrorFormat, JVariant strError) throws AutomationException

method IsValidEx

Throws:

AutomationException

validateOnServer

public boolean validateOnServer(Enums.SPYValidateErrorFormat nErrorFormat, JVariant strError) throws AutomationException

method ValidateOnServer - restricted access

Throws:

AutomationException

generateJSONSchemaDocumentation

public void generateJSONSchemaDocumentation(JSONSchemaDocumentationDlg i_ipDlg) throws AutomationException

method GenerateJSONSchemaDocumentation

Throws:

AutomationException