public class QuerySchema
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Method and Description |
---|---|
java.util.HashMap<java.lang.String,java.lang.String> |
getAdditionalFields()
Returns the map of additional field keys and values
|
java.lang.String |
getAdditionalFieldValue(java.lang.String key)
Returns the value from the additionalFields mapping corresponding to the given key
|
int |
getDataElementSize() |
java.lang.String |
getDataSchemaName()
Returns the name of the data schema.
|
java.util.List<java.lang.String> |
getElementNames()
Returns the element names to include in the response.
|
DataFilter |
getFilter()
Returns the data element filter for this query.
|
java.util.Set<java.lang.String> |
getFilteredElementNames()
Returns the set of element names on which to apply the filter.
|
java.lang.String |
getFilterTypeName()
Returns the name of the filter class for this query.
|
java.lang.String |
getSchemaName()
Returns the name of this schema.
|
java.lang.String |
getSelectorName()
Returns the element name used as the selector.
|
public java.lang.String getSchemaName()
public java.lang.String getDataSchemaName()
This query is designed to be run over data described by this data schema.
public java.util.List<java.lang.String> getElementNames()
The element names are defined by the data schema associated with this query.
public java.lang.String getSelectorName()
The element names are defined by the data schema associated with this query.
public int getDataElementSize()
public java.lang.String getFilterTypeName()
DataFilter
interface.null
if there is no filter defined.public java.util.Set<java.lang.String> getFilteredElementNames()
public DataFilter getFilter()
The data filter is applied to the getFilteredElementNames()
data elements.
null
if no filter has been specified for this query.public java.util.HashMap<java.lang.String,java.lang.String> getAdditionalFields()
Note that additional fields are optional, thus the map may be empty
public java.lang.String getAdditionalFieldValue(java.lang.String key)
key
-