Package adams.db
Class LogEntryConditions
-
- All Implemented Interfaces:
Destroyable,GlobalInfoSupporter,LoggingLevelHandler,LoggingSupporter,OptionHandler,PreGetOptionslistHook,SizeOfHandler,Serializable
public class LogEntryConditions extends AbstractLimitedConditions
Conditions for retrieving log entries.
Valid options are:
-D <int> (property: debugLevel) The greater the number the more additional info the scheme may output to the console (0 = off). default: 0 minimum: 0
-limit <int> (property: limit) The maximum number of records to retrieve. default: 10000 minimum: -1
-host <adams.core.base.BaseRegExp> (property: host) The host name to use in the search (regular expression). default:
-ip <adams.core.base.BaseRegExp> (property: IP) The IP address to use in the search (regular expression). default:
-type <adams.core.base.BaseRegExp> (property: type) The log entry type to use in the search (regular expression). default:
-status <adams.core.base.BaseRegExp> (property: status) The log entry status to use in the search (regular expression). default:
-source <adams.core.base.BaseRegExp> (property: source) The log entry type to use in the search (regular expression). default:
-generation-start <adams.core.base.BaseDateTime> (property: generationStartDate) The start date for the log entry generation. default: -INF
-generation-end <adams.core.base.BaseDateTime> (property: generationEndDate) The end date for the log entry generation. default: +INF
-latest (property: latest) Returns only the latest entries, i.e., works backwards from the generation end date.
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected BaseDateTimem_GenerationEndDatethe end date of the log entries.protected BaseDateTimem_GenerationStartDatethe start date of the log entries.protected BaseRegExpm_Hostthe host name (regexp).protected BaseRegExpm_IPthe IP address (regexp).protected booleanm_Latestwhether to return the latest entries.protected BaseRegExpm_Sourcethe source of the log entries (regexp).protected BaseRegExpm_Statusthe status of the log entries (regexp).protected BaseRegExpm_Typethe type of the log entries (regexp).-
Fields inherited from class adams.db.AbstractLimitedConditions
m_Limit
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description LogEntryConditions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddefineOptions()Adds options to the internal list of options.StringgenerationEndDateTipText()Returns the tip text for this property.StringgenerationStartDateTipText()Returns the tip text for this property.BaseDateTimegetGenerationEndDate()Returns the generation end date.BaseDateTimegetGenerationStartDate()Returns the generation start date.BaseRegExpgetHost()Returns the host name to use in the search.BaseRegExpgetIP()Returns the IP address to use in the search.booleangetLatest()Returns whether to return only the latest (most recent) entries only.BaseRegExpgetSource()Returns the source used in the search.BaseRegExpgetStatus()Returns the status used in the search.BaseRegExpgetType()Returns the type used in the search.StringglobalInfo()Returns a string describing the object.StringhostTipText()Returns the tip text for this property.StringIPTipText()Returns the tip text for this property.StringlatestTipText()Returns the tip text for this property.voidsetGenerationEndDate(BaseDateTime value)Sets the generation end date.voidsetGenerationStartDate(BaseDateTime value)Sets the generation start date.voidsetHost(BaseRegExp value)Sets the host name to use in the search.voidsetIP(BaseRegExp value)Sets the IP address to use in the search.voidsetLatest(boolean value)Sets whether to return the latest (most recent) entries only.voidsetSource(BaseRegExp value)Sets the source to use in the search.voidsetStatus(BaseRegExp value)Sets the status to use in the search.voidsetType(BaseRegExp value)Sets the type to use in the search.StringsourceTipText()Returns the tip text for this property.StringstatusTipText()Returns the tip text for this property.StringtypeTipText()Returns the tip text for this property.voidupdate()Automatically corrects values.-
Methods inherited from class adams.db.AbstractLimitedConditions
getDefaultLimit, getLimit, limitTipText, setLimit
-
Methods inherited from class adams.db.AbstractConditions
check, compareTo, equals, forCommandLine, forName, getFilters, preGetOptionsList, shallowCopy, shallowCopy
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
Field Detail
-
m_Host
protected BaseRegExp m_Host
the host name (regexp).
-
m_IP
protected BaseRegExp m_IP
the IP address (regexp).
-
m_Type
protected BaseRegExp m_Type
the type of the log entries (regexp).
-
m_Status
protected BaseRegExp m_Status
the status of the log entries (regexp).
-
m_Source
protected BaseRegExp m_Source
the source of the log entries (regexp).
-
m_GenerationStartDate
protected BaseDateTime m_GenerationStartDate
the start date of the log entries.
-
m_GenerationEndDate
protected BaseDateTime m_GenerationEndDate
the end date of the log entries.
-
m_Latest
protected boolean m_Latest
whether to return the latest entries.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractLimitedConditions
-
setHost
public void setHost(BaseRegExp value)
Sets the host name to use in the search.- Parameters:
value- the host name
-
getHost
public BaseRegExp getHost()
Returns the host name to use in the search.- Returns:
- the host name
-
hostTipText
public String hostTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setIP
public void setIP(BaseRegExp value)
Sets the IP address to use in the search.- Parameters:
value- the IP address
-
getIP
public BaseRegExp getIP()
Returns the IP address to use in the search.- Returns:
- the IP address
-
IPTipText
public String IPTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setType
public void setType(BaseRegExp value)
Sets the type to use in the search.- Parameters:
value- the type
-
getType
public BaseRegExp getType()
Returns the type used in the search.- Returns:
- the type
-
typeTipText
public String typeTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setStatus
public void setStatus(BaseRegExp value)
Sets the status to use in the search.- Parameters:
value- the status
-
getStatus
public BaseRegExp getStatus()
Returns the status used in the search.- Returns:
- the status
-
statusTipText
public String statusTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setSource
public void setSource(BaseRegExp value)
Sets the source to use in the search.- Parameters:
value- the source
-
getSource
public BaseRegExp getSource()
Returns the source used in the search.- Returns:
- the source
-
sourceTipText
public String sourceTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setGenerationStartDate
public void setGenerationStartDate(BaseDateTime value)
Sets the generation start date.- Parameters:
value- the start date
-
getGenerationStartDate
public BaseDateTime getGenerationStartDate()
Returns the generation start date.- Returns:
- the start date
-
generationStartDateTipText
public String generationStartDateTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setGenerationEndDate
public void setGenerationEndDate(BaseDateTime value)
Sets the generation end date.- Parameters:
value- the end date
-
getGenerationEndDate
public BaseDateTime getGenerationEndDate()
Returns the generation end date.- Returns:
- the end date
-
generationEndDateTipText
public String generationEndDateTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setLatest
public void setLatest(boolean value)
Sets whether to return the latest (most recent) entries only.- Parameters:
value- true if the latest entries are to be returned
-
getLatest
public boolean getLatest()
Returns whether to return only the latest (most recent) entries only.- Returns:
- true if the latest entries are returned
-
latestTipText
public String latestTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
update
public void update()
Automatically corrects values.- Specified by:
updatein classAbstractConditions
-
-