Package com.altova.automation.XMLSpy

Class Application

java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

com.altova.automation.libs.AutomationServer

com.altova.automation.XMLSpy.Application

public class Application
extends AutomationServer

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

Constructors

Constructor	Description
Application()	XMLSpy_x64 application class Application default class constructor

Method Summary

Modifier and Type	Method	Description
void	addMacroMenuItem(java.lang.String strMacro, java.lang.String strDisplayText)	method AddMacroMenuItem
void	addXSLT_XQParameter(java.lang.String sName, java.lang.String sXPath)	Adds XSLT Input ParameterXQuery External Variable
void	clearMacroMenu()	method ClearMacroMenu
Document	createXMLSchemaFromDBStructure(DatabaseConnection pSettings, JVariant tables)	Creates a new Schema document from a given DB structure.
void	enableAutoBackup()	Perform document recovery and enable auto-backup
FindInFilesResults	findInFiles(FindInFilesDlg pSettings)	Performs a search (or replacement) for the specified text.
Document	getActiveDocument()	Reference to the active document.
COMIDispatchObject	getApplication()	property Application
SpyProject	getCurrentProject()	property CurrentProject
ElementList	getDatabaseImportElementList(DatabaseConnection pImportSettings)	GetDatabaseImportElementList retrieves information about the database as specified in pImportSettings to create the list of elements ppElementList.
DatabaseConnection	getDatabaseSettings()	GetDatabaseSettings creates a new object of database settings.
ElementList	getDatabaseTables(DatabaseConnection pImportSettings)	GetDatabaseTables reads the table names from the database.
Dialogs	getDialogs()	property Dialogs
Documents	getDocuments()	Collection of all open documents.
java.lang.String	getEdition()	Edition of product.
GUID	getEventInterfaceIID()
ExportSettings	getExportSettings()	GetExportSettings creates a new object of common export settings.
GUID	getInterfaceIID()
boolean	getIsAPISupported()	Returns whether API is supported in this version.
int	getMajorVersion()	Major version of product.
int	getMinorVersion()	Minor version of product.
COMIDispatchObject	getParent()	property Parent
RaptorXMLServers	getRaptorXMLServers()	Access list of configured RaptorXML servers.
java.lang.Object	getScriptingEnvironment()	Reference to any active scripting environment.
int	getServicePackVersion()	Service pack version of product, e.g.
Enums.ENUMApplicationStatus	getStatus()	property Status
ElementList	getTextImportElementList(TextImportExportSettings pImportSettings)	GetTextImportElementList gets information about the text-file as specified in pImportSettings.
TextImportExportSettings	getTextImportExportSettings()	GetTextImportExportSettings creates a new object of common import and export settings for text-files.
java.lang.String	getValidateOnServerPredefinedCommand()	get name of predefined command for use by ValidateOnServer
boolean	getVisible()	property Visible
short	getWarningNumber()	property WarningNumber
java.lang.String	getWarningText()	property WarningText
long	getWindowHandle()	property WindowHandle
int	getXSLT_XQParameterCount()	Get XSLT Input ParameterXQuery External Variable count
java.lang.String	getXSLT_XQParameterName(int n)	Get XSLT Input ParameterXQuery External Variable name
java.lang.String	getXSLT_XQParameterXPath(int n)	Get XSLT Input ParameterXQuery External Variable XPath
Document	importFromDatabase(DatabaseConnection pImportSettings, ElementList pElementList)	ImportFromDatabase imports the database as specified in pImportSettings.
Document	importFromSchema(DatabaseConnection pImportSettings, java.lang.String strTable, Document pSchemaDoc)	method ImportFromSchema
Document	importFromText(TextImportExportSettings pImportSettings, ElementList pElementList)	ImportFromText imports the text-file as specified in pImportSettings.
Document	importFromWord(java.lang.String strFile)	ImportFromWord imports the Word-Document strFile.
void	newProject(java.lang.String strPath, boolean bDiscardCurrent)	Create and open a new empty XMLSpy project file.
void	openProject(java.lang.String strPath, boolean bDiscardCurrent, boolean bDialog)	OpenProject opens an existing project.
Document	openSchemaFromDatabase(java.lang.String strConnectionString, java.lang.String strAltovaFilePathSchema)	Opens a XML Schema from a database
Document	openSchemaFromDatabaseEx(java.lang.String strConnectionString, java.lang.String strUser, java.lang.String strPassword, java.lang.String strClassOrAssemblyName, java.lang.String strAltovaFilePathSchema)	Opens an XML Schema from a database
void	quit()	method Quit
void	reloadSettings()	The application settings are reloaded from the registry.
void	removeXSLT_XQParameter(int n)	Remove XSLT Input ParameterXQuery External Variable
void	runMacro(java.lang.String strMacroName)	Calls the specified macro either from the project scripts (if present) or from the global scripts.
void	setSelection(java.lang.String newValue)	Opens the specified document and performs the selection.
void	setValidateOnServerPredefinedCommand(java.lang.String newValue)	get name of predefined command for use by ValidateOnServer
void	setVisible(boolean newValue)	property Visible
void	showApplication(boolean bShow)	method ShowApplication
boolean	showFindInFiles(FindInFilesDlg pSettings)	Shows the FindInFiles window with the given settings.
int	showForm(java.lang.String strName)	method ShowForm
void	uRLDelete(java.lang.String strURL, java.lang.String strUser, java.lang.String strPassword)	method URLDelete
void	uRLMakeDirectory(java.lang.String strURL, java.lang.String strUser, java.lang.String strPassword)	method URLMakeDirectory

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

getApplicationName

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

Constructor Details

Application

public Application() throws AutomationException

XMLSpy_x64 application class Application default class constructor

Throws:

AutomationException

Method Details

getInterfaceIID

public GUID getInterfaceIID()

getEventInterfaceIID

public GUID getEventInterfaceIID()

newProject

public void newProject(java.lang.String strPath, boolean bDiscardCurrent) throws AutomationException

Create and open a new empty XMLSpy project file.

Parameters:

strPath - - full path to the project file (extension .spp)

bDiscardCurrent - - true if any changes made to currently open project shall be discarded?

Throws:

AutomationException

openProject

public void openProject(java.lang.String strPath, boolean bDiscardCurrent, boolean bDialog) throws AutomationException

OpenProject opens an existing project.

Throws:

AutomationException

getDocuments

public Documents getDocuments() throws AutomationException

Collection of all open documents.

Throws:

AutomationException

getActiveDocument

public Document getActiveDocument() throws AutomationException

Reference to the active document.

Throws:

AutomationException

getDatabaseSettings

public DatabaseConnection getDatabaseSettings() throws AutomationException

GetDatabaseSettings creates a new object of database settings. See also ImportFromDatabase.

Throws:

AutomationException

getExportSettings

public ExportSettings getExportSettings() throws AutomationException

GetExportSettings creates a new object of common export settings. See also the export functions from document.

Throws:

AutomationException

getTextImportExportSettings

public TextImportExportSettings getTextImportExportSettings() throws AutomationException

GetTextImportExportSettings creates a new object of common import and export settings for text-files.

Throws:

AutomationException

getTextImportElementList

public ElementList getTextImportElementList(TextImportExportSettings pImportSettings) throws AutomationException

GetTextImportElementList gets information about the text-file as specified in pImportSettings. See also ImportFromText.

Throws:

AutomationException

importFromText

public Document importFromText(TextImportExportSettings pImportSettings, ElementList pElementList) throws AutomationException

ImportFromText imports the text-file as specified in pImportSettings. pElementList declares the tables to import.

Throws:

AutomationException

importFromDatabase

public Document importFromDatabase(DatabaseConnection pImportSettings, ElementList pElementList) throws AutomationException

ImportFromDatabase imports the database as specified in pImportSettings. pElementList declares the tables to import.

Throws:

AutomationException

getDatabaseImportElementList

public ElementList getDatabaseImportElementList(DatabaseConnection pImportSettings) throws AutomationException

GetDatabaseImportElementList retrieves information about the database as specified in pImportSettings to create the list of elements ppElementList. See also ImportFromDatabase.

Throws:

AutomationException

importFromWord

public Document importFromWord(java.lang.String strFile) throws AutomationException

ImportFromWord imports the Word-Document strFile.

Throws:

AutomationException

getDatabaseTables

public ElementList getDatabaseTables(DatabaseConnection pImportSettings) throws AutomationException

GetDatabaseTables reads the table names from the database.

Throws:

AutomationException

getWarningNumber

public short getWarningNumber() throws AutomationException

property WarningNumber

Throws:

AutomationException

getWarningText

public java.lang.String getWarningText() throws AutomationException

property WarningText

Throws:

AutomationException

getCurrentProject

public SpyProject getCurrentProject() throws AutomationException

property CurrentProject

Throws:

AutomationException

showForm

public int showForm(java.lang.String strName) throws AutomationException

method ShowForm

Throws:

AutomationException

addMacroMenuItem

public void addMacroMenuItem(java.lang.String strMacro, java.lang.String strDisplayText) throws AutomationException

method AddMacroMenuItem

Throws:

AutomationException

clearMacroMenu

public void clearMacroMenu() throws AutomationException

method ClearMacroMenu

Throws:

AutomationException

quit

public void quit() throws AutomationException

method Quit

Throws:

AutomationException

showApplication

public void showApplication(boolean bShow) throws AutomationException

method ShowApplication

Throws:

AutomationException

uRLDelete

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

method URLDelete

Throws:

AutomationException

uRLMakeDirectory

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

method URLMakeDirectory

Throws:

AutomationException

importFromSchema

public Document importFromSchema(DatabaseConnection pImportSettings, java.lang.String strTable, Document pSchemaDoc) throws AutomationException

method ImportFromSchema

Throws:

AutomationException

getApplication

public COMIDispatchObject getApplication() throws AutomationException

property Application

Throws:

AutomationException

getParent

public COMIDispatchObject getParent() throws AutomationException

property Parent

Throws:

AutomationException

getDialogs

public Dialogs getDialogs() throws AutomationException

property Dialogs

Throws:

AutomationException

getVisible

public boolean getVisible() throws AutomationException

property Visible

Throws:

AutomationException

setVisible

public void setVisible(boolean newValue) throws AutomationException

property Visible

Throws:

AutomationException

getWindowHandle

public long getWindowHandle() throws AutomationException

property WindowHandle

Throws:

AutomationException

runMacro

public void runMacro(java.lang.String strMacroName) throws AutomationException

Calls the specified macro either from the project scripts (if present) or from the global scripts.

Throws:

AutomationException

getScriptingEnvironment

public java.lang.Object getScriptingEnvironment() throws AutomationException

Reference to any active scripting environment.

Throws:

AutomationException

reloadSettings

public void reloadSettings() throws AutomationException

The application settings are reloaded from the registry.

Throws:

AutomationException

findInFiles

public FindInFilesResults findInFiles(FindInFilesDlg pSettings) throws AutomationException

Performs a search (or replacement) for the specified text.

Throws:

AutomationException

showFindInFiles

public boolean showFindInFiles(FindInFilesDlg pSettings) throws AutomationException

Shows the FindInFiles window with the given settings.

Throws:

AutomationException

setSelection

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

Opens the specified document and performs the selection.

Throws:

AutomationException

openSchemaFromDatabase

public Document openSchemaFromDatabase(java.lang.String strConnectionString, java.lang.String strAltovaFilePathSchema) throws AutomationException

Opens a XML Schema from a database

Throws:

AutomationException

getStatus

public Enums.ENUMApplicationStatus getStatus() throws AutomationException

property Status

Throws:

AutomationException

getMajorVersion

public int getMajorVersion() throws AutomationException

Major version of product. e.g. 8 for 2006 R2 SP1

Throws:

AutomationException

getMinorVersion

public int getMinorVersion() throws AutomationException

Minor version of product. e.g. 2 for 2006 R2 SP1

Throws:

AutomationException

getEdition

public java.lang.String getEdition() throws AutomationException

Edition of product. e.g. returns "Altova XMLSpy Enterprise Edition" for the enterprise edition

Throws:

AutomationException

getIsAPISupported

public boolean getIsAPISupported() throws AutomationException

Returns whether API is supported in this version.

Throws:

AutomationException

getServicePackVersion

public int getServicePackVersion() throws AutomationException

Service pack version of product, e.g. 1 for 2010 R2 SP1

Throws:

AutomationException

createXMLSchemaFromDBStructure

public Document createXMLSchemaFromDBStructure(DatabaseConnection pSettings, JVariant tables) throws AutomationException

Creates a new Schema document from a given DB structure.

Throws:

AutomationException

addXSLT_XQParameter

public void addXSLT_XQParameter(java.lang.String sName, java.lang.String sXPath) throws AutomationException

Adds XSLT Input ParameterXQuery External Variable

Throws:

AutomationException

getXSLT_XQParameterCount

public int getXSLT_XQParameterCount() throws AutomationException

Get XSLT Input ParameterXQuery External Variable count

Throws:

AutomationException

getXSLT_XQParameterName

public java.lang.String getXSLT_XQParameterName(int n) throws AutomationException

Get XSLT Input ParameterXQuery External Variable name

Throws:

AutomationException

getXSLT_XQParameterXPath

public java.lang.String getXSLT_XQParameterXPath(int n) throws AutomationException

Get XSLT Input ParameterXQuery External Variable XPath

Throws:

AutomationException

removeXSLT_XQParameter

public void removeXSLT_XQParameter(int n) throws AutomationException

Remove XSLT Input ParameterXQuery External Variable

Throws:

AutomationException

openSchemaFromDatabaseEx

public Document openSchemaFromDatabaseEx(java.lang.String strConnectionString, java.lang.String strUser, java.lang.String strPassword, java.lang.String strClassOrAssemblyName, java.lang.String strAltovaFilePathSchema) throws AutomationException

Opens an XML Schema from a database

Throws:

AutomationException

getRaptorXMLServers

public RaptorXMLServers getRaptorXMLServers() throws AutomationException

Access list of configured RaptorXML servers.

Throws:

AutomationException

getValidateOnServerPredefinedCommand

public java.lang.String getValidateOnServerPredefinedCommand() throws AutomationException

get name of predefined command for use by ValidateOnServer

Throws:

AutomationException

setValidateOnServerPredefinedCommand

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

get name of predefined command for use by ValidateOnServer

Throws:

AutomationException

enableAutoBackup

public void enableAutoBackup() throws AutomationException

Perform document recovery and enable auto-backup

Throws:

AutomationException