ag.ion.bion.officelayer.internal.application
Class AbstractOfficeApplication

java.lang.Object
  ag.ion.bion.officelayer.internal.application.AbstractOfficeApplication

All Implemented Interfaces:

IOfficeApplication, IDisposeable

Direct Known Subclasses:

LocalOfficeApplication, RemoteOfficeApplication

public abstract class AbstractOfficeApplication
extends java.lang.Object
implements IOfficeApplication

Abstract OpenOffice.org application.

Field Summary

Fields inherited from interface ag.ion.bion.officelayer.application.IOfficeApplication

APPLICATION_HOME_KEY, APPLICATION_HOST_KEY, APPLICATION_PORT_KEY, APPLICATION_TYPE_KEY, LOCAL_APPLICATION, REMOTE_APPLICATION

Constructor Summary

AbstractOfficeApplication()

Method Summary

void	activate() Activates office application.
void	activate(IOfficeProgressMonitor officeProgressMonitor) Activates office application.
void	deactivate() Deactivates the office application.
void	dispose() Disposes all allocated resources.
IDesktopService	getDesktopService() Returns desktop service of the application.
IDocumentService	getDocumentService() Returns document service.
IServiceProvider	getServiceProvider() Returns service provider.
boolean	isActive() Returns information whether the office application is active or not.
protected abstract void	openConnection(IOfficeProgressMonitor officeProgressMonitor) Opens connection to OpenOffice.org.
protected void	setOfficeApplicationConfiguration(IOfficeApplicationConfiguration officeApplicationConfiguration) Sets office application configuration configuration.
protected void	setOfficeConnection(IOfficeConnection officeConnection) Sets office connection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ag.ion.bion.officelayer.application.IOfficeApplication

getApplicationType, isConfigured, setConfiguration, setConfiguration

Constructor Detail

AbstractOfficeApplication

public AbstractOfficeApplication()

Method Detail

activate

public void activate(IOfficeProgressMonitor officeProgressMonitor)
              throws OfficeApplicationException

Activates office application.

Specified by:

activate in interface IOfficeApplication

Parameters:

officeProgressMonitor - office progress monitor to be used

Throws:

OfficeApplicationException - if the office application can not be activated

activate

public void activate()
              throws OfficeApplicationException

Activates office application.

Specified by:

activate in interface IOfficeApplication

Throws:

OfficeApplicationException - if the office application can not be activated

deactivate

public void deactivate()
                throws OfficeApplicationException

Deactivates the office application. This call will not terminate the OpenOffice.org process - it will only dispose the internal communication bridge to OpenOffice.org.

Specified by:

deactivate in interface IOfficeApplication

Throws:

OfficeApplicationException - if the office application can not be deactivated

isActive

public boolean isActive()

Returns information whether the office application is active or not. This information is not an indicator for a running native OpenOffice.org process.

Specified by:

isActive in interface IOfficeApplication

Returns:

whether the office application is active or not

getDocumentService

public IDocumentService getDocumentService()
                                    throws OfficeApplicationException

Returns document service. Return null if the office application is not running.

Specified by:

getDocumentService in interface IOfficeApplication

Returns:

document service or null if the office application is not running

Throws:

OfficeApplicationException - if the document service is not available

getDesktopService

public IDesktopService getDesktopService()
                                  throws OfficeApplicationException

Returns desktop service of the application.

Specified by:

getDesktopService in interface IOfficeApplication

Returns:

desktop service of the application

Throws:

OfficeApplicationException - if the desktop service is not available

dispose

public void dispose()

Disposes all allocated resources.

Specified by:

dispose in interface IDisposeable

getServiceProvider

public IServiceProvider getServiceProvider()

Returns service provider. Returns null if the application is not active.

Specified by:

getServiceProvider in interface IOfficeApplication

Returns:

service provider null if the application is not active

openConnection

protected abstract void openConnection(IOfficeProgressMonitor officeProgressMonitor)
                                throws OfficeApplicationException

Opens connection to OpenOffice.org. Subclasses must implement this method in order to activate the application and they must supply the constructed connection to the base class.

Parameters:

officeProgressMonitor - office progress monitor to be used (can be null)

Throws:

OfficeApplicationException - if the connection can not be established

setOfficeApplicationConfiguration

protected void setOfficeApplicationConfiguration(IOfficeApplicationConfiguration officeApplicationConfiguration)

Sets office application configuration configuration.

Parameters:

officeApplicationConfiguration - office application configuration configuration

setOfficeConnection

protected void setOfficeConnection(IOfficeConnection officeConnection)

Sets office connection.

Parameters:

officeConnection - office connection