FilterObj MethodsA Sandcastle Documented Class Library
The FilterObj type exposes the following members.
Methods

  NameDescription
Public methodGetActive
Returns a value indicatnig if this filter obj is currently active.
Public methodGetColumnAsString
Returns the column value as a string for the given database column.
Private methodGetConfigTableSchema
Executes the config table query template for each config table listed in the database.
Public methodGetCurrentFilterId
Returns the id of the currently loaded filter if there is one.
Public methodGetDataRow
Returns the database record for this filter.
Public methodGetFilterCreatedOn
Returns the filter creation date.
Public methodGetFilterDesc
Returns the filter description.
Public methodGetFilterFromWizard
Returns if this filter is from a wizard.
Public methodGetFilterIcon
Returns the filter icon name.
Public methodGetFilterIsPublic
Returns the filter is public flag.
Public methodGetFilterMode
Gets the filter mode for this object.
Public methodGetFilterName
Returns the filter name.
Public methodGetFilterPopulationStatLoadingComplete
Returns true if the population results have been loaded.
Public methodGetFilterType
Represents the current filter type.
Public methodGetHasPopStats
Returns true if this filter has its population statistics loaded.
Public methodGetHasReports
Returns true if this object has reports.
Public methodGetHasStats
Returns true if this object has statistics.
Public methodGetJoinType
Returns the join type used here.
Public methodGetLegacyCriteriaObject
Returns a copy of the legacy criteria object as a basic object.
Public methodGetMaxReports
Returns the conifgured number of max reports.
Public methodGetMaxStatistics
Returns the maximum statistics value for the app.
Public methodGetPopData
Returns the population statistics data set for this filter object.
Public methodGetPopStatCount
Returns the number of population statistics found, should always be the same number.
Public methodGetPopulationStatisticsErrorCount
Returns an error count from the QueryResultSet received from the population statistics data load.
Public methodGetPopulationStatisticsQueryResultSet
Returns a QueryResultSet from the population statistics data load.
Public methodGetPrctGeoCodedDbl
Returns a double representation of the current geo coding percentage.
Public methodGetPrctGeoCodedStr
Returns a string representation of the current geo coding percentage.
Public methodGetReportAtIndex
Returns the ReportObj at the given index.
Public methodGetReportCount
Reports the number of report entries.
Public methodGetReportIndexOfReportWithId
Returns a report index for the object with the given id.
Public methodGetReportList
Returns a reference to the report list object.
Public methodGetReportWithId
Returns a report object with the given id.
Public methodGetReportWithName
Returns a ReportObj with the given name.
Public methodGetSqlCoded
Returns the coded version of the SQL for this filter object.
Public methodGetSqlLiteral
Returns the literal version of the SQL for this filter object.
Public methodGetSqlQueryCoded
Returns the coded sql query object.
Public methodGetSqlQueryLiteral
Returns the literal sql query object.
Public methodGetStatAtIndex
Returns the statistic object at the given index.
Public methodGetStatCount
Returns the number of statistics found.
Public methodGetStatData
Returns the stat data for this filter object.
Public methodGetStatisticsErrorCount
Returns an error count from the QueryResultSet received from the statistics data load.
Public methodGetStatisticsQueryResultSet
Returns a QueryResultSet from the statistics data load.
Public methodGetStatList
Returns a reference to the statistic list object.
Public methodGetStatResultsLoadingComplete
Returns true of the statistic results have been loaded.
Public methodGetStatWithId
Returns the currently loaded statistics with the given stat id.
Public methodGetStatWithName
Returns the currently loaded statistic with the given name.
Public methodGetUserId
Returns the user id of the current filter object.
Public methodLoadFilter(String)
Loads a filter from the database row data.
Public methodLoadFilter(String, Boolean)
Loads a filter from the database row data.
Public methodLoadFilterPopulationStats
Loads up the population statistics for this filter object.
Private methodLoadFilterPopulationStatsAsync
Runs the population statistic load in a thread.
Public methodLoadReports 
Loads reports with the given default information.
Public methodLoadReports(String, String)
Loads a set of reports for the given criteria.
Public methodLoadStatistics 
Loads the statistics for this filter obj using the filter object's username and filter id. Defaults passive to false.
Public methodLoadStatistics(Boolean)
Loads the statistics for this filter obj using the filter object's username and filter id.
Public methodLoadStatistics(String, String)
Loads up statistic information, forces a recalculation of the statistics payload.
Public methodLoadStatistics(String, String, Boolean)
Loads up associated statistics for this filter object if they exist. Passive = true, won't run statistics payload. Passive = false, will run statistics payload.
Public methodLoadStatResults
Runs the stat results calculation.
Private methodLoadStatResultsAsync
Runs the stat resutls calculation in a thread.
Private methodNormalizeLegacyFilterObject
Normalize legacy filter data for updated filter object use.
Private methodNormalizeUpdatedFilterObject
Normalize filter object data for use.
Private methodPrep
Prepares some class variables for a filter load.
Private methodPrintLegacyCriteriaObj
Print the contents of a legacy Criteria object.
Private methodPrintLegacyCriterionObj
Prints the contents of a legacy Criterion object.
Public methodResetStatLoadingFlags
Resets the statistic loading flags for forcing a stat reload.
Public methodSetFilterMode
Sets the filter mode for this object.
Public methodSetJoinType
Set the join type.
Public methodSetMaxReports
Sets the maximum number of reports that can be associated with a filter object.
Public methodSetMaxStatistics
Sets the maximum statistics value for the app.
Public methodSetPopData
Sets the population statistic data to the given data table.
Public methodSetStatData
Sets the user statistic data to the given data table.
Public methodSetStatResultsLoadingComplete
Sets the stat results loading complete bool tp the given argument.
Public methodToString
Overridden ToString method, prints out information about this filter object.
(Overrides Object ToString .)
Private methodwr
Logging method only works if the logging boolean is toggled.
Back to Top
See Also