| Overview | Package | Class | Tree | Index | Help | NetCharts Pro (Applets) 7.0 | ||
| PREV CLASS | NEXT CLASS | FRAMES | NO FRAMES | ||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||
java.lang.Object | +--netcharts.util.NFDataBean
| Field Summary | |
| NFContext | ctxt
The context in which this DataBean is operating. |
| java.lang.String | desc
|
| java.lang.String | exprParam
The parameter associated with this DataBean. |
| java.lang.String | keyword
|
| static int | LOAD_LATER
|
| static int | LOAD_NONE
|
| static int | LOAD_NOW
|
| java.lang.String | name
|
| java.lang.String | prefix
|
| Method Summary | |
| java.lang.Object | clone()
Clone this DataBean. |
| void | close()
Close any open connections and release all system resources associated with this data source. |
| void | debug(java.lang.String msg)
Prints the given debug message if the current debugMode has been selected. |
| void | defineParams(NFParam p)
Define the parameters for this DataBean. |
| NFContext | getContext()
Returns the context in which this databean is operating. |
| java.lang.String | getDesc()
Returns a description for this data bean type. |
| java.lang.String | getExprParam()
Returns the parameter associated with the keyword expression being processed by this data bean. |
| java.lang.String | getKeyword()
Returns the keyword used for all expressions for this data bean type. |
| java.lang.String | getName()
Returns the name used to refer to this data bean type. |
| java.lang.StringBuffer | getParam(java.lang.String param,
java.lang.StringBuffer sb)
This method is called to append the parameter definition for the given parameter name, based on the current data bean properties, to the given string buffer and returns a pointer to that buffer. |
| java.util.Vector | getParams(java.util.Vector v)
This method is called to return parameter definitions for all of the parameters associated with the current data bean. |
| java.lang.String | getPrefix()
Returns the prefix used for all parameters for this data bean type. |
| boolean | inDebugMode()
Returns true if the current debugMode specified for the databean has been selected. |
| boolean | loadData(NFDataBeanObserver observer,
java.lang.Object info)
This method is called in order to load the data associated with the current data bean. |
| void | loadParams(NFParam p)
Load the parameters for this DataBean. |
| boolean | reloadNeeded(java.util.Date timestamp)
This method is called to determine if the current databean needs to be reloaded based on the given timestamp. |
| void | setContext(NFContext ctxt)
This method is used to set the context in which the databean is performing its processing. |
| void | setExprParam(java.lang.String exprParam)
Sets the parameter associated with the keyword expression being processed by this data bean. |
| void | start()
This method is called in order to restart a databean that may have been stopped because the graph was stopped. |
| void | statusMsg(java.lang.String title,
java.lang.String msg)
Writes the message to the debug object. |
| void | stop()
This method is called whenever the graph has been stopped. |
| java.lang.String | toString()
Returns a string representation of the databean |
| void | toString(java.lang.StringBuffer sb)
Appends a string representation of the databean to the buffer |
| Field Detail |
public static final int LOAD_NONE
public static final int LOAD_NOW
public static final int LOAD_LATER
protected java.lang.String name
protected java.lang.String desc
protected java.lang.String prefix
protected java.lang.String keyword
protected java.lang.String exprParam
protected NFContext ctxt
| Method Detail |
protected boolean inDebugMode()
protected void debug(java.lang.String msg)
msg
- The debug message.
protected void statusMsg(java.lang.String title,
java.lang.String msg)
title
- The title of the status window.
msg
- The status message.public java.lang.String getName()
public java.lang.String getDesc()
public java.lang.String getPrefix()
public java.lang.String getKeyword()
public void defineParams(NFParam p)
throws java.lang.Exception
The
- parameter object to define the parameters in.
public void loadParams(NFParam p)
throws java.lang.Exception
The
- parameter object to load the parameters from.public java.lang.String getExprParam()
public void setExprParam(java.lang.String exprParam)
exprParam
- The parameter name to be associated with this DataBean.
public java.lang.StringBuffer getParam(java.lang.String param,
java.lang.StringBuffer sb)
If the given parameter name is invalid, null is returned.
If the string buffer pointer is null on input, a private string buffer will be returned, which will only be valid until the next call to this method for this data bean.
param
- The name of the parameter to retrieve.
sb
- The buffer to append the parameter definition to.public java.util.Vector getParams(java.util.Vector v)
The vector should contain NFKeyValue objects, in which the key field points to a String parameter name and the value field points to a StringBuffer parameter definition.
This method is called by NFCdf when generating a parameter script that contains data bean expressions.
v
- The Vector to append the parameter definitions to.public void setContext(NFContext ctxt)
ctxt
- The new context to set.public NFContext getContext()
public boolean loadData(NFDataBeanObserver observer,
java.lang.Object info)
throws java.lang.Exception
If the data bean needs to get additional user input before the data can be loaded (eg. a password) then it will display an appropriate dialog window and will return true, indicating that the caller should suspend current processing and wait until the user has input the information.
Once the user has successfully entered the information, the data will be loaded and the observer's dataBeanUserInput() method will be called to signify that the interactive processing is over, at which time the caller can resume its processing.
observer
- The observer loading the data.
info
- The argument.public void close()
public boolean reloadNeeded(java.util.Date timestamp)
This method always returns true and should be overridden by each databean.
timestamp
- The date to compare against.public java.lang.String toString()
public void toString(java.lang.StringBuffer sb)
sb
- The buffer to append to.public void start()
public void stop()
public java.lang.Object clone()
| Overview | Package | Class | Tree | Index | Help | |||
| PREV CLASS | NEXT CLASS | FRAMES | NO FRAMES | ||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||
| Visual Mining, Inc. | Copyright © Visual Mining, Inc. 1996 - 2010 |
Last Modified: Jun 29, 2010 |