public class DescribeHandler extends java.lang.Object implements FormatStructureHandler, FormatDataHandler
Modifier and Type | Class and Description |
---|---|
static class |
DescribeHandler.OperationType |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTE_DEFAULT_VALUE |
static java.lang.String |
BATCH_PARTS |
static java.lang.String |
CANONICAL |
static java.lang.String |
CANONICAL_DESCRIBE |
static java.lang.String |
CARDIANALITY |
static java.lang.String |
CHILD |
static java.lang.String |
COLLECTION |
static char |
COMMA |
static java.lang.String |
CONNECTION_CONTEXT_KEY |
static java.lang.String |
CONNECTION_ID_KEY |
static java.lang.String |
CREATE_ACTION_ENABLED |
static java.lang.String |
DELETE_ACTION_ENABLED |
static java.lang.String |
HIDDEN |
static java.lang.String |
HREF |
static java.lang.String |
ID |
static java.lang.String |
IS_CANONICAL_ACCESSOR |
static java.lang.String |
ITEMS |
static java.lang.String |
KIND |
static java.lang.String |
LINKS |
static java.lang.String |
LOV_BINDING_MAP |
static java.lang.String |
LOV_FIELD_NAMES |
static java.lang.String |
LOV_LINK |
static java.lang.String |
NAME |
static java.lang.String |
OPERATION |
static java.lang.String |
PAYLOAD |
static java.lang.String |
PROPERTIES_MAPPER_KEY |
static java.lang.String |
REL |
static java.lang.String |
ROW_FINDER |
static java.lang.String |
SELF |
static java.lang.String |
SELF_URL |
static java.lang.String |
TOTAL_RESULTS |
Constructor and Description |
---|
DescribeHandler(java.io.InputStream descStream) |
DescribeHandler(com.fasterxml.jackson.databind.node.ObjectNode resourceNode,
java.lang.String resourceName) |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> |
getAccessorUrlsMap() |
java.util.List<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> |
getBatchResult() |
java.lang.Object |
getOperationResult() |
static java.io.Reader |
getReader(java.io.InputStream descStream) |
java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> |
getResourceMap() |
java.lang.Object |
getResult(java.util.Map params,
java.lang.String returnType)
Returns the resulting data extracted from the input.
|
StructureDefinition |
getStructure(java.lang.String name,
DefinitionContext ctx)
Returns the structure definition extracted for the data format.
|
void |
setHttpHeaderName(java.lang.String httpHeaderName) |
void |
setIncludeHttpHeader(boolean includeHttpHeader) |
void |
setPathParamMap(java.util.Map pathParamMap) |
void |
setQueryParamMap(java.util.Map queryParamMap) |
void |
setResourceName(java.lang.String resourceName) |
public static final java.lang.String CANONICAL
public static final java.lang.String ROW_FINDER
public static final java.lang.String CONNECTION_CONTEXT_KEY
public static final java.lang.String CONNECTION_ID_KEY
public static final java.lang.String PROPERTIES_MAPPER_KEY
public static final java.lang.String LOV_BINDING_MAP
public static final java.lang.String LOV_FIELD_NAMES
public static final java.lang.String ATTRIBUTE_DEFAULT_VALUE
public static final char COMMA
public static final java.lang.String COLLECTION
public static final java.lang.String NAME
public static final java.lang.String LINKS
public static final java.lang.String ITEMS
public static final java.lang.String HREF
public static final java.lang.String REL
public static final java.lang.String CHILD
public static final java.lang.String LOV_LINK
public static final java.lang.String TOTAL_RESULTS
public static final java.lang.String CARDIANALITY
public static final java.lang.String SELF
public static final java.lang.String KIND
public static final java.lang.String HIDDEN
public static final java.lang.String SELF_URL
public static final java.lang.String CANONICAL_DESCRIBE
public static final java.lang.String CREATE_ACTION_ENABLED
public static final java.lang.String DELETE_ACTION_ENABLED
public static final java.lang.String ID
public static final java.lang.String OPERATION
public static final java.lang.String PAYLOAD
public static final java.lang.String IS_CANONICAL_ACCESSOR
public static final java.lang.String BATCH_PARTS
public DescribeHandler(java.io.InputStream descStream)
public DescribeHandler(com.fasterxml.jackson.databind.node.ObjectNode resourceNode, java.lang.String resourceName)
public void setIncludeHttpHeader(boolean includeHttpHeader)
public void setHttpHeaderName(java.lang.String httpHeaderName)
public void setPathParamMap(java.util.Map pathParamMap)
public void setQueryParamMap(java.util.Map queryParamMap)
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getAccessorUrlsMap()
public void setResourceName(java.lang.String resourceName)
public java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> getResourceMap()
public StructureDefinition getStructure(java.lang.String name, DefinitionContext ctx)
FormatStructureHandler
getStructure
in interface FormatStructureHandler
name
- name of the root structure.ctx
- definition context information.public java.util.List<java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> getBatchResult()
public java.lang.Object getResult(java.util.Map params, java.lang.String returnType)
FormatDataHandler
getResult
in interface FormatDataHandler
params
- parameters passed containig the context information.returnType
- data type of the returned value. This can be passed as null.
If no return type is specified, an Iterator of Map will be returned.returnType
parameter.
If the type is available, an instance of that object is created. If no
type is specified an Iterator
of Map
objects
for the result will be created.
If no data found it can return null. The Map
contains the value of attributes as defined in the data structure.
For complex data, Map
s can contain other
Map
s as well.public java.lang.Object getOperationResult()
@Concealed public static java.io.Reader getReader(java.io.InputStream descStream)