The FilterObj type exposes the following members.
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
  | FilterObj | |
 | FilterObj |
Generic constructor.
|
| FilterObj(Boolean, Boolean) |
General constructor with options for debug settings.
|
| FilterObj(SqlJoinType, FilterMode) |
Enhanced constructor lets you set some global attributes.
|
Methods
| Name | Description | |
|---|---|---|
| GetActive |
Returns a value indicatnig if this filter obj is currently active.
|
| GetColumnAsString |
Returns the column value as a string for the given database column.
|
| GetConfigTableSchema |
Executes the config table query template for each config table listed in the database.
|
| GetCurrentFilterId |
Returns the id of the currently loaded filter if there is one.
|
| GetDataRow |
Returns the database record for this filter.
|
| GetFilterCreatedOn |
Returns the filter creation date.
|
| GetFilterDesc |
Returns the filter description.
|
| GetFilterFromWizard |
Returns if this filter is from a wizard.
|
| GetFilterIcon |
Returns the filter icon name.
|
| GetFilterIsPublic |
Returns the filter is public flag.
|
| GetFilterMode |
Gets the filter mode for this object.
|
| GetFilterName |
Returns the filter name.
|
| GetFilterPopulationStatLoadingComplete |
Returns true if the population results have been loaded.
|
| GetFilterType |
Represents the current filter type.
|
| GetHasPopStats |
Returns true if this filter has its population statistics loaded.
|
| GetHasReports |
Returns true if this object has reports.
|
| GetHasStats |
Returns true if this object has statistics.
|
| GetJoinType |
Returns the join type used here.
|
| GetLegacyCriteriaObject |
Returns a copy of the legacy criteria object as a basic object.
|
| GetMaxReports |
Returns the conifgured number of max reports.
|
| GetMaxStatistics |
Returns the maximum statistics value for the app.
|
| GetPopData |
Returns the population statistics data set for this filter object.
|
| GetPopStatCount |
Returns the number of population statistics found, should always be the same number.
|
| GetPopulationStatisticsErrorCount |
Returns an error count from the QueryResultSet received from
the population statistics data load.
|
| GetPopulationStatisticsQueryResultSet |
Returns a QueryResultSet from the population statistics data load.
|
| GetPrctGeoCodedDbl |
Returns a double representation of the current geo coding percentage.
|
| GetPrctGeoCodedStr |
Returns a string representation of the current geo coding percentage.
|
| GetReportAtIndex |
Returns the ReportObj at the given index.
|
| GetReportCount |
Reports the number of report entries.
|
| GetReportIndexOfReportWithId |
Returns a report index for the object with the given id.
|
| GetReportList |
Returns a reference to the report list object.
|
| GetReportWithId |
Returns a report object with the given id.
|
| GetReportWithName |
Returns a ReportObj with the given name.
|
| GetSqlCoded |
Returns the coded version of the SQL for this filter object.
|
| GetSqlLiteral |
Returns the literal version of the SQL for this filter object.
|
| GetSqlQueryCoded |
Returns the coded sql query object.
|
| GetSqlQueryLiteral |
Returns the literal sql query object.
|
| GetStatAtIndex |
Returns the statistic object at the given index.
|
| GetStatCount |
Returns the number of statistics found.
|
| GetStatData |
Returns the stat data for this filter object.
|
| GetStatisticsErrorCount |
Returns an error count from the QueryResultSet received from
the statistics data load.
|
| GetStatisticsQueryResultSet |
Returns a QueryResultSet from the statistics data load.
|
| GetStatList |
Returns a reference to the statistic list object.
|
| GetStatResultsLoadingComplete |
Returns true of the statistic results have been loaded.
|
| GetStatWithId |
Returns the currently loaded statistics with the given stat id.
|
| GetStatWithName |
Returns the currently loaded statistic with the given name.
|
| GetUserId |
Returns the user id of the current filter object.
|
| LoadFilter(String) |
Loads a filter from the database row data.
|
| LoadFilter(String, Boolean) |
Loads a filter from the database row data.
|
| LoadFilterPopulationStats |
Loads up the population statistics for this filter object.
|
| LoadFilterPopulationStatsAsync |
Runs the population statistic load in a thread.
|
| LoadReports |
Loads reports with the given default information.
|
| LoadReports(String, String) |
Loads a set of reports for the given criteria.
|
| LoadStatistics |
Loads the statistics for this filter obj using the filter object's username and filter id.
Defaults passive to false.
|
| LoadStatistics(Boolean) |
Loads the statistics for this filter obj using the filter object's username and filter id.
|
| LoadStatistics(String, String) |
Loads up statistic information, forces a recalculation of the statistics payload.
|
| LoadStatistics(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.
|
| LoadStatResults |
Runs the stat results calculation.
|
| LoadStatResultsAsync |
Runs the stat resutls calculation in a thread.
|
| NormalizeLegacyFilterObject |
Normalize legacy filter data for updated filter object use.
|
| NormalizeUpdatedFilterObject |
Normalize filter object data for use.
|
| Prep |
Prepares some class variables for a filter load.
|
| PrintLegacyCriteriaObj |
Print the contents of a legacy Criteria object.
|
| PrintLegacyCriterionObj |
Prints the contents of a legacy Criterion object.
|
| ResetStatLoadingFlags |
Resets the statistic loading flags for forcing a stat reload.
|
| SetFilterMode |
Sets the filter mode for this object.
|
| SetJoinType |
Set the join type.
|
| SetMaxReports |
Sets the maximum number of reports that can be associated with a filter object.
|
| SetMaxStatistics |
Sets the maximum statistics value for the app.
|
| SetPopData |
Sets the population statistic data to the given data table.
|
| SetStatData |
Sets the user statistic data to the given data table.
|
| SetStatResultsLoadingComplete |
Sets the stat results loading complete bool tp the given argument.
|
| ToString |
Overridden ToString method, prints out information about this filter object.
(Overrides Object ToString .) |
| wr |
Logging method only works if the logging boolean is toggled.
|
Fields
| Name | Description | |
|---|---|---|
 | ASYNC |
Controls whether or not statistics and reports are loaded up asynchronously.
|
| configTables |
Holds the filter systems list of tables used to build queries on.
|
| configTableSelect |
Query template used to load the top row from each
filter config table. Row is used for column name and data type information.
|
| coreTables |
The table that holds the db table linking data.
|
| currentFilterId |
Holds the current filter id.
|
| filterEntry |
Holds the data in the FILTER table for a given filter id.
|
| join |
Toggles the join type used when building the filter query.
|
| key |
Encrypted key for communicating with the web service.
|
| legacyFilterObjColumn |
Database column that holds the legacy binary serialized filter object data.
|
| logging |
Turns console logging on and off
|
| maxReports |
Holds the maximum number of statistic entries in the system.
|
| maxStats |
Holds the maximum number of statistic entries in the system.
|
| mode |
Toggles the filter mode used when building the filter query.
|
| NO_LOADING |
If true, prevents loading of pop stats, user stats, and user reports on the server side.
|
| noConfigTableSchemaFoundErrMsg |
Error message for not being able to load a row from a config table.
|
| noConfigTablesErrMsg |
Error message for not being able to load the config tables list.
|
| noFilterEntryErrMsg |
Error message for not being able to load the filter entry.
|
| p4s2CriteriaObj |
Legacy object support, used to bring binary data from the filter table into a VB object.
New entries will use serialized text or XML that is base64 encoded.
|
| popData |
Holds the population statistics for this filter object.
|
| popQrs |
Holds information about all of the queries ran for the filter's basic statistics.
|
| popStatLoadingComplete |
Keeps track of the state of the population statistics loading.
|
| prctGeoCodedDbl |
Holds the percent of geocoded claims associated with thise filter.
|
| prctGeoCodedStr | |
| queryCoded |
Holds the current filter query in object form.
This query is to be used for the actual database call and uses
a coded value that users couldn't understand.
|
| queryLegacyCoded |
SqlQuery object used to hold legacy query information in coded form.
|
| queryLegacyIdx |
Internal variable that tracks the index of the SqlTokens as they are built from legacy objects.
|
| queryLegacyLevel |
Internal variable for tracking the recursive levels of the legacy filter object.
|
| queryLegacyLiteral |
SqlQuery object used to hold legacy query information in literal form.
|
| queryLiteral |
Holds the current filter query in object form.
This query is to be used for the literal representation the user
sees in the presentation layer.
|
| reports |
Holds all associated report objects.
|
| secretKey |
Clear key used to communicate with the web service.
|
| statData |
Holds the statistics results set for this filter.
|
| statQrs |
Holds information about all of the queries ran for this filter's statistics.
|
| statResultsLoadingComplete |
Keeps track of the state of the stat results loading.
|
| stats |
Holds all associated statistic objects.
|
| svc |
Reference to the web service.
|
| tableSchema |
Holds a DataRow from each of the config tables, references by table name.
|
| testMode |
Turns on test mode to use TSRCSERVER7 for filter entries.
|
| type |
The type of filter we have, legacy or new
|
| unexpectedLegacyObjetcErrMsg |
Error message for when the binary legacy data can't be loaded into a Criteria object.
|
| updatedFilterObjColumnCoded |
Database column that holds the new text serialized filter object data, coded version.
|
| updatedFilterObjColumnLiteral |
Database column that holds the new test serialized filter object data, literal version.
|
See Also