org.opennms.netmgt.dao.castor

Class SiteStatusViewsFactory

java.lang.Object

org.opennms.netmgt.dao.castor.SiteStatusViewsFactory

public class SiteStatusViewsFactory
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SiteStatusViewsFactory(InputStream stream) Constructor for SiteStatusViewsFactory.
SiteStatusViewsFactory(String configFile) Constructor for SiteStatusViewsFactory.

Method Summary

Methods

Modifier and Type	Method and Description
static SiteStatusViewConfiguration	getConfig() getConfig
static SiteStatusViewsFactory	getInstance() Singleton static call to get the only instance that should exist for the ViewsDisplayFactory
View	getView(String viewName) Can't be null
static Map<String,View>	getViewsMap() getViewsMap
static void	init() Be sure to call this method before calling getInstance().
void	reload() reload
static void	setConfig(SiteStatusViewConfiguration m_config) setConfig
static void	setInstance(SiteStatusViewsFactory instance) setInstance
static void	setViewsMap(Map<String,View> map) setViewsMap
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

initialized

protected boolean initialized

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

m_lastModified

protected static long m_lastModified

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

m_viewsMap

protected static Map<String,View> m_viewsMap

Map of view objects by name.

Constructor Detail

SiteStatusViewsFactory

public SiteStatusViewsFactory(String configFile)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException,
                              IOException

Constructor for SiteStatusViewsFactory.

Parameters:

configFile - a String object.

Throws:

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

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

IOException - if any.

SiteStatusViewsFactory

public SiteStatusViewsFactory(InputStream stream)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException

Constructor for SiteStatusViewsFactory.

Parameters:

stream - a InputStream object.

Throws:

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

org.exolab.castor.xml.ValidationException - 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 SiteStatusViewsFactory 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

setInstance

public static void setInstance(SiteStatusViewsFactory instance)

setInstance

Parameters:

instance - a SiteStatusViewsFactory object.

reload

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

reload

Throws:

IOException - if any.

FileNotFoundException - if any.

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

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

getView

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

Can't 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.

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.

getConfig

public static SiteStatusViewConfiguration getConfig()

getConfig

Returns:

a SiteStatusViewConfiguration object.

setConfig

public static void setConfig(SiteStatusViewConfiguration m_config)

setConfig

Parameters:

m_config - a SiteStatusViewConfiguration object.

getViewsMap

public static Map<String,View> getViewsMap()

getViewsMap

Returns:

a Map object.

setViewsMap

public static void setViewsMap(Map<String,View> map)

setViewsMap

Parameters:

map - a Map object.