TODO GwClassListService Documentation
Package: `com.geowebframework.dataservice.service`
Description: A service class that provides functionalities for building responses, executing queries, and managing metadata-related operations in the context of GeoWebFramework applications.
Methods
init
Description: Initializes the service and registers it in the GeoWeb Registry.
Parameters: None
Returns: `void`
—
buildListRangeResponseHttpEntity
Description: Builds a response entity for a paginated list of data.
Parameters:
`rangeString` (String): Defines the range of the requested data.
`gwClass` (Class): The GeoWeb class object.
`sort` (String): Sorting criteria.
`query` (Query): Query object with filter and selection criteria.
`locale` (Locale): Locale for localization.
Returns: `HttpEntity<List<HashMap<String, Object»>`
Throws: Exception
—
buildListRangeResponseHttpEntity (Overload)
Description: Builds a response entity for a paginated list of data, including specific attributes.
Parameters:
`rangeString` (String): Defines the range of the requested data.
`gwClass` (Class): The GeoWeb class object.
`attributeList` (ArrayList<Attribute>): List of attributes to include.
`sort` (String): Sorting criteria.
`query` (Query): Query object with filter and selection criteria.
`locale` (Locale): Locale for localization.
Returns: `HttpEntity<List<HashMap<String, Object»>`
Throws: Exception
—
buildListQueryString
Description: Constructs a query string for fetching list data.
Parameters:
`projectName` (String): Name of the project.
`gwClass` (Class): The GeoWeb class.
`sort` (String): Sorting criteria.
`filterQueryMap` (HashMap<String, Object>): Map of query filters.
`filterMap` (HashMap<Filter, ArrayList<Object»): Map of additional filters.
`al` (ArrayList<Attribute>): List of attributes to include in the query.
`locale` (Locale): Locale for localization.
Returns: `Query`
Throws: Exception
—
buildListQueryString (Overload)
Description: Constructs a query string for fetching list data with optional values and clauses.
Parameters:
`projectName` (String): Name of the project.
`gwClass` (Class): The GeoWeb class.
`sort` (String): Sorting criteria.
`filterQueryMap` (HashMap<String, Object>): Map of query filters.
`filterMap` (HashMap<Filter, ArrayList<Object»): Map of additional filters.
`al` (ArrayList<Attribute>): List of attributes to include in the query.
`valuesMap` (HashMap<String, Object>): Optional values map.
`queryClausole` (String): Optional query clauses.
`locale` (Locale): Locale for localization.
Returns: `Query`
Throws: Exception
—
selectClassRecordsUsingFilterList
Description: Retrieves class records based on a list of filters.
Parameters:
`gwClass` (Class): The GeoWeb class object.
`filterList` (List<Filter>): List of filters to apply.
Returns: `ArrayList<HashMap<String, Object»`
Throws: Exception
—
selectClassRecordsUsingFilterList (Overload)
Description: Retrieves class records based on filters with additional options like project name and order.
Parameters:
`gwClassName` (String): Name of the GeoWeb class.
`filterList` (List<Filter>): List of filters to apply.
`projectName` (String): Optional project name.
`orderArray` (String[]): Optional array of ordering criteria.
Returns: `ArrayList<HashMap<String, Object»`
Throws: Exception
—
deleteClassRecordWithoutTransaction
Description: Deletes a single class record without using a transaction.
Parameters:
`projectName` (String): Name of the project.
`gwClass` (Class): The GeoWeb class object.
`itemId` (Object): Identifier of the record to delete.
`options` (Map<String, Object>): Additional options for the deletion.
Returns: `boolean`
Throws: Exception
—
deleteClassRecordsWithoutTransaction
Description: Deletes multiple class records without using a transaction.
Parameters:
`projectName` (String): Name of the project.
`gwClassName` (String): Name of the GeoWeb class.
`itemIdList` (ArrayList<String>): List of record identifiers to delete.
`options` (Map<String, Object>): Additional options for the deletion.
Returns: `boolean`
Throws: Exception
—
countClassRecordsUsingFilterList
Description: Counts the class records based on filters.
Parameters:
`gwClassName` (String): Name of the GeoWeb class.
`filterList` (List<Filter>): List of filters to apply.
`projectName` (String): Optional project name.
Returns: `Integer`
Throws: Exception
—
createFilersAndPopulateValuesMap
Description: Creates filters and populates the values map for a query.
Parameters:
`query` (Query): Query object.
`filterQueryMap` (Map<String, Object>): Map of query filters.
`valuesMap` (Map<String, Object>): Values map to populate.
`tableIndex` (Integer): Index of the table.
Returns: `void`
Throws: Exception
—
… (other methods to follow in this format) …
Notes
This documentation is generated based on the methods publicly available in the `GwClassListService` class. Each method is documented individually, even if there are similarities between methods.
Integration
To include this documentation in DokuWiki, copy and paste it into a page with the desired namespace. The structure adheres to DokuWiki's syntax for headings and lists, ensuring a clear and navigable layout.