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.

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:

  1. `rangeString` (String): Defines the range of the requested data.
  2. `gwClass` (Class): The GeoWeb class object.
  3. `sort` (String): Sorting criteria.
  4. `query` (Query): Query object with filter and selection criteria.
  5. `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:

  1. `rangeString` (String): Defines the range of the requested data.
  2. `gwClass` (Class): The GeoWeb class object.
  3. `attributeList` (ArrayList<Attribute>): List of attributes to include.
  4. `sort` (String): Sorting criteria.
  5. `query` (Query): Query object with filter and selection criteria.
  6. `locale` (Locale): Locale for localization.

Returns: `HttpEntity<List<HashMap<String, Object»>`

Throws: Exception

buildListQueryString

Description: Constructs a query string for fetching list data.

Parameters:

  1. `projectName` (String): Name of the project.
  2. `gwClass` (Class): The GeoWeb class.
  3. `sort` (String): Sorting criteria.
  4. `filterQueryMap` (HashMap<String, Object>): Map of query filters.
  5. `filterMap` (HashMap<Filter, ArrayList<Object»): Map of additional filters.
  6. `al` (ArrayList<Attribute>): List of attributes to include in the query.
  7. `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:

  1. `projectName` (String): Name of the project.
  2. `gwClass` (Class): The GeoWeb class.
  3. `sort` (String): Sorting criteria.
  4. `filterQueryMap` (HashMap<String, Object>): Map of query filters.
  5. `filterMap` (HashMap<Filter, ArrayList<Object»): Map of additional filters.
  6. `al` (ArrayList<Attribute>): List of attributes to include in the query.
  7. `valuesMap` (HashMap<String, Object>): Optional values map.
  8. `queryClausole` (String): Optional query clauses.
  9. `locale` (Locale): Locale for localization.

Returns: `Query`

Throws: Exception

selectClassRecordsUsingFilterList

Description: Retrieves class records based on a list of filters.

Parameters:

  1. `gwClass` (Class): The GeoWeb class object.
  2. `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:

  1. `gwClassName` (String): Name of the GeoWeb class.
  2. `filterList` (List<Filter>): List of filters to apply.
  3. `projectName` (String): Optional project name.
  4. `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:

  1. `projectName` (String): Name of the project.
  2. `gwClass` (Class): The GeoWeb class object.
  3. `itemId` (Object): Identifier of the record to delete.
  4. `options` (Map<String, Object>): Additional options for the deletion.

Returns: `boolean`

Throws: Exception

deleteClassRecordsWithoutTransaction

Description: Deletes multiple class records without using a transaction.

Parameters:

  1. `projectName` (String): Name of the project.
  2. `gwClassName` (String): Name of the GeoWeb class.
  3. `itemIdList` (ArrayList<String>): List of record identifiers to delete.
  4. `options` (Map<String, Object>): Additional options for the deletion.

Returns: `boolean`

Throws: Exception

countClassRecordsUsingFilterList

Description: Counts the class records based on filters.

Parameters:

  1. `gwClassName` (String): Name of the GeoWeb class.
  2. `filterList` (List<Filter>): List of filters to apply.
  3. `projectName` (String): Optional project name.

Returns: `Integer`

Throws: Exception

createFilersAndPopulateValuesMap

Description: Creates filters and populates the values map for a query.

Parameters:

  1. `query` (Query): Query object.
  2. `filterQueryMap` (Map<String, Object>): Map of query filters.
  3. `valuesMap` (Map<String, Object>): Values map to populate.
  4. `tableIndex` (Integer): Index of the table.

Returns: `void`

Throws: Exception

… (other methods to follow in this format) …

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.

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.

  • custom/api_java_gw_data_classservice.txt
  • Ultima modifica: 2024/12/12 18:05
  • da giorgio.scali