org.opennms.netmgt.config

Class ViewsDisplayFactory

java.lang.Object

org.opennms.netmgt.config.ViewsDisplayFactory

public class ViewsDisplayFactory
extends Object

ViewsDisplayFactory class.

Version:

$Id: $

Author:

ranger

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized Boolean indicating if the init() method has been called.
protected long	m_lastModified Timestamp of the viewDisplay file, used to know when to reload from disk.
protected File	m_viewsDisplayFile File path of groups.xml.
protected Map<String,org.opennms.netmgt.config.viewsdisplay.View>	m_viewsMap Map of view objects by name.

Constructor Summary

Constructors

Constructor and Description
ViewsDisplayFactory(String file) Constructor for ViewsDisplayFactory.

Method Summary

Methods

Modifier and Type	Method and Description
org.opennms.netmgt.config.viewsdisplay.View	getDefaultView() getDefaultView
int	getDisconnectTimeout() getDisconnectTimeout
static ViewsDisplayFactory	getInstance() Singleton static call to get the only instance that should exist for the ViewsDisplayFactory
org.opennms.netmgt.config.viewsdisplay.View	getView(String viewName) Can be null
File	getViewsDisplayFile() getViewsDisplayFile
static void	init() Be sure to call this method before calling getInstance().
void	reload() Parses the viewsdisplay.xml via the Castor classes
static void	setInstance(ViewsDisplayFactory instance) setInstance
void	setViewsDisplayFile(File viewsDisplayFile) setViewsDisplayFile
protected void	updateFromFile() Reload the viewsdisplay.xml file if it has been changed since we last read it.

Methods inherited from class java.lang.Object

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

Field Detail

m_viewsDisplayFile

protected File m_viewsDisplayFile

File path of groups.xml.

initialized

protected boolean initialized

Boolean indicating if the init() method has been called.

m_lastModified

protected long m_lastModified

Timestamp of the viewDisplay file, used to know when to reload from disk.

m_viewsMap

protected Map<String,org.opennms.netmgt.config.viewsdisplay.View> m_viewsMap

Map of view objects by name.

Constructor Detail

ViewsDisplayFactory

public ViewsDisplayFactory(String file)
                    throws org.exolab.castor.xml.MarshalException,
                           org.exolab.castor.xml.ValidationException,
                           FileNotFoundException,
                           IOException

Constructor for ViewsDisplayFactory.

Parameters:

file - a String object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

FileNotFoundException - if any.

IOException - if any.

Method Detail

init

public static void init()
                 throws IOException,
                        FileNotFoundException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

Be sure to call this method before calling getInstance().

Throws:

IOException - if any.

FileNotFoundException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getInstance

public static ViewsDisplayFactory getInstance()

Singleton static call to get the only instance that should exist for the ViewsDisplayFactory

Returns:

the single views display factory instance

Throws:

IllegalStateException - if init has not been called

reload

public void reload()
            throws IOException,
                   FileNotFoundException,
                   org.exolab.castor.xml.MarshalException,
                   org.exolab.castor.xml.ValidationException

Parses the viewsdisplay.xml via the Castor classes

Throws:

IOException - if any.

FileNotFoundException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

setViewsDisplayFile

public void setViewsDisplayFile(File viewsDisplayFile)

setViewsDisplayFile

Parameters:

viewsDisplayFile - a File object.

getViewsDisplayFile

public File getViewsDisplayFile()
                         throws IOException

getViewsDisplayFile

Returns:

a File object.

Throws:

IOException - if any.

getView

public org.opennms.netmgt.config.viewsdisplay.View getView(String viewName)
                                                    throws IOException,
                                                           org.exolab.castor.xml.MarshalException,
                                                           org.exolab.castor.xml.ValidationException

Can be null

Parameters:

viewName - a String object.

Returns:

a View object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getDefaultView

public org.opennms.netmgt.config.viewsdisplay.View getDefaultView()

getDefaultView

Returns:

a View object.

updateFromFile

protected void updateFromFile()
                       throws IOException,
                              org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException

Reload the viewsdisplay.xml file if it has been changed since we last read it.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

setInstance

public static void setInstance(ViewsDisplayFactory instance)

setInstance

Parameters:

instance - a ViewsDisplayFactory object.

getDisconnectTimeout

public int getDisconnectTimeout()

getDisconnectTimeout

Returns:

a int.