@Encoded public class GeoNodeHandler extends AbstractResourceHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String | ACCESS_PROFILE_DETAILS_INFORMATION
The Constant ACCESS_PROFILE_DETAILS_INFORMATION.
|
static java.lang.String | COPYRIGHT
IBM Copyright notice field.
|
static java.lang.String | FORMAT_GROUP_NAME
The constant FORMAT_GROUP_NAME
|
static java.lang.String | GEO_TOP_RESOURCE_MAPPING_KEY
The Constant GEO_TOP_RESOURCE_MAPPING_KEY.
|
protected GeoNodeHelper | helper
Helper to retrieve and deal with BOD.
|
static java.lang.String | PARAMETER_PARENT_GEO_ID
parent Geo Node identifier
|
static java.lang.String | PARAMETER_PARENT_GEO_ID_DESCRIPTION
parent Geo Node identifier description
|
static java.lang.String | PARAMETER_SITE_LEVEL_SEARCH
site level search flag
|
static java.lang.String | PARAMETER_SITE_LEVEL_SEARCH_DESCRIPTION
site level search flag description
|
static java.lang.String | RESOURCE_NAME
The Constant RESOURCE_NAME.
|
Constructor and Description |
---|
GeoNodeHandler() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response | findByQuery(java.lang.String storeId, java.lang.String queryName)
Find geo nodes based on query name.
|
javax.ws.rs.core.Response | findGeoByParentGeoId(java.lang.String storeId, java.lang.String parentgeoid, java.lang.String responseFormat)
This method retrieves geo nodes by parent geo node unique ID.
|
javax.ws.rs.core.Response | findGeoByTypeAndName(java.lang.String storeId)
Find geo nodes that match the type and the name.
|
javax.ws.rs.core.Response | findTopGeoNodes(java.lang.String storeId, java.lang.String responseFormat)
Deprecated.
Adding query parameter "siteLevelSearch"
|
javax.ws.rs.core.Response | findTopGeoNodes(java.lang.String storeId, java.lang.String responseFormat, java.lang.String siteLevelSearch)
This method retrieves top geo nodes details.
|
protected javax.ws.rs.core.Response | generateResponse(ShowGeoNodeDataAreaType dataArea, java.lang.String urlParamGroupName, java.lang.String responseFormat)
Generates REST response from a given data object and its corresponding URL parameter group name from the BOD to URL mapping configuration.
|
java.lang.String | getFormattingGroupName()
Returns the formatting group name for resolving the struts action of the formatting JSP.
|
GeoNodeHelper | getHelper()
Return the BOD helper associated with the geo node resource.
|
java.lang.String | getResourceName()
This method returns the name of the resource used primarily to determine the representation of the resource.
|
void | initializeQueryRegistry(OperationRegistry registry)
Initializes the registry mapping between the query names and the methods being called to handle requests.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String ACCESS_PROFILE_DETAILS_INFORMATION
public static final java.lang.String RESOURCE_NAME
public static final java.lang.String GEO_TOP_RESOURCE_MAPPING_KEY
public static final java.lang.String PARAMETER_SITE_LEVEL_SEARCH
public static final java.lang.String PARAMETER_SITE_LEVEL_SEARCH_DESCRIPTION
public static final java.lang.String PARAMETER_PARENT_GEO_ID
public static final java.lang.String PARAMETER_PARENT_GEO_ID_DESCRIPTION
public static final java.lang.String FORMAT_GROUP_NAME
protected GeoNodeHelper helper
public void initializeQueryRegistry(OperationRegistry registry)
public java.lang.String getResourceName()
public java.lang.String getFormattingGroupName()
public GeoNodeHelper getHelper()
public javax.ws.rs.core.Response findTopGeoNodes(java.lang.String storeId, java.lang.String responseFormat, java.lang.String siteLevelSearch)
public javax.ws.rs.core.Response findTopGeoNodes(java.lang.String storeId, java.lang.String responseFormat)
public javax.ws.rs.core.Response findGeoByParentGeoId(java.lang.String storeId, java.lang.String parentgeoid, java.lang.String responseFormat)
public javax.ws.rs.core.Response findGeoByTypeAndName(java.lang.String storeId)
public javax.ws.rs.core.Response findByQuery(java.lang.String storeId, java.lang.String queryName)
protected javax.ws.rs.core.Response generateResponse(ShowGeoNodeDataAreaType dataArea, java.lang.String urlParamGroupName, java.lang.String responseFormat)
This method calls createMapForProvider to create the response data map. The response status code is resolved based on the input parameters.