oracle.ifs.core.util

Class JsonPreparedSelector

java.lang.Object

oracle.ifs.core.util.JsonPreparedSelector

public class JsonPreparedSelector
extends Object

Encapsulates JSON used to define or persist a PreparedSelector definition.

Author:

Dave Long

Constructor Summary

Constructors

Constructor and Description
JsonPreparedSelector(Document doc) Constructs a JsonPreparedSelector from a Document whose content is the JSON content.
JsonPreparedSelector(LibrarySession session, JsonObject jsonObject) Constructs a JsonPreparedSelector from a JSON object.
JsonPreparedSelector(LibrarySession session, Reader reader) Constructs a JsonPreparedSelector from a Reader whose content is the JSON content.
JsonPreparedSelector(LibrarySession session, String jsonString) Constructs a JsonPreparedSelector from a String representation of the JSON content.
JsonPreparedSelector(PreparedSelectorGenerator psGen) Constructs a JsonPreparedSelector from a PreparedSelectorGenerator definition.
JsonPreparedSelector(PreparedSelectorGenerator psGen, PreparedSelector psel) Constructs a JsonPreparedSelector from PreparedSelectorGenerator and associated PreparedSelector definitions.

Method Summary

Modifier and Type	Method and Description
protected void	createPreparedSelectorGenerator() Creates the PreparedSelectorGenerator representation of the search definition.
protected void	define(Document doc) Define the JsonPreparedSelector from a Document whose content is the JSON content.
protected void	define(JsonObject jsonObject) Define the JsonPreparedSelector from a JSON object.
void	define(PreparedSelectorGenerator psGen, PreparedSelector psel) Define the JsonPreparedSelector from PreparedSelectorGenerator and associated PreparedSelector definitions.
protected void	define(Reader reader) Define the JsonPreparedSelector from a Reader whose content is the JSON content.
protected void	define(String jsonString) Define the JsonPreparedSelector from a String representation of the JSON content.
protected AttributeValue[]	getBindValues(List<AttributeValueTable> bindValueList) Gets the bind values defined in the specified table list.
JsonObject	getJsonObject() Gets the JsonObject representation of the search definition.
String	getJsonString() Gets the JSON string representation of the search definition.
PreparedSelector	getPreparedSelector() Gets the PreparedSelector representation of the search definition.
PreparedSelectorGenerator	getPreparedSelectorGenerator() Gets the PreparedSelectorGenerator representation of the search definition.
protected AttributeValue	getSearchTarget(AttributeValueTable targetTable) Gets a search target from search target specification stored in an AttributeValueTable.
protected AttributeValue	getSearchTarget(String targetTag) Gets a search target from search target specification.
protected AttributeValue[]	getSearchTargets(List<AttributeValueTable> targetTables) Gets search Targets from a list of target definition tables.
protected AttributeValue[]	getSearchTargets(String targetsTag) Gets search Targets from a comma delimitted string defintion.
protected AttributeValue[]	getSearchTargets(String[] targetTags) Gets search Targets from an array of target tags.
LibrarySession	getSession() Gets the session context.
void	setBindValues(AttributeValue[] bindValues) Sets the bind values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonPreparedSelector

public JsonPreparedSelector(Document doc)
                     throws IfsException

Constructs a JsonPreparedSelector from a Document whose content is the JSON content.

Parameters:

doc - the Document

Throws:

IfsException - if the operation fails.

JsonPreparedSelector

public JsonPreparedSelector(LibrarySession session,
                            Reader reader)
                     throws IfsException

Constructs a JsonPreparedSelector from a Reader whose content is the JSON content.

Parameters:

session - the session context

reader - the Reader

Throws:

IfsException - if the operation fails.

JsonPreparedSelector

public JsonPreparedSelector(LibrarySession session,
                            String jsonString)
                     throws IfsException

Constructs a JsonPreparedSelector from a String representation of the JSON content.

Parameters:

session - the session context

jsonString - the JSON content

Throws:

IfsException - if the operation fails.

JsonPreparedSelector

public JsonPreparedSelector(LibrarySession session,
                            JsonObject jsonObject)
                     throws IfsException

Constructs a JsonPreparedSelector from a JSON object.

Parameters:

session - the session context

jsonObject - the JSON object

Throws:

IfsException - if the operation fails.

JsonPreparedSelector

public JsonPreparedSelector(PreparedSelectorGenerator psGen)
                     throws IfsException

Constructs a JsonPreparedSelector from a PreparedSelectorGenerator definition.

Parameters:

psGen - the PreparedSelectorGenerator

Throws:

IfsException - if the operation fails.

JsonPreparedSelector

public JsonPreparedSelector(PreparedSelectorGenerator psGen,
                            PreparedSelector psel)
                     throws IfsException

Constructs a JsonPreparedSelector from PreparedSelectorGenerator and associated PreparedSelector definitions.

Parameters:

psGen - the PreparedSelectorGenerator

psel - the PreparedSelector

Throws:

IfsException - if the operation fails.

Method Detail

define

protected void define(Document doc)
               throws IfsException

Define the JsonPreparedSelector from a Document whose content is the JSON content.

Parameters:

doc - the Document

Throws:

IfsException - if the operation fails.

define

protected void define(Reader reader)
               throws IfsException

Define the JsonPreparedSelector from a Reader whose content is the JSON content.

Parameters:

reader - the Reader

Throws:

IfsException - if the operation fails.

define

protected void define(String jsonString)
               throws IfsException

Define the JsonPreparedSelector from a String representation of the JSON content.

Parameters:

jsonString - the JSON content

Throws:

IfsException - if the operation fails.

define

protected void define(JsonObject jsonObject)
               throws IfsException

Define the JsonPreparedSelector from a JSON object.

Parameters:

jsonObject - the JSON object

Throws:

IfsException - if the operation fails.

define

public void define(PreparedSelectorGenerator psGen,
                   PreparedSelector psel)
            throws IfsException

Define the JsonPreparedSelector from PreparedSelectorGenerator and associated PreparedSelector definitions.

Parameters:

psGen - the PreparedSelectorGenerator

psel - the PreparedSelector

Throws:

IfsException - if the operation fails.

getSession

public LibrarySession getSession()
                          throws IfsException

Gets the session context.

Returns:

the current session context

Throws:

IfsException - if the operation fails.

getJsonObject

public JsonObject getJsonObject()
                         throws IfsException

Gets the JsonObject representation of the search definition.

Returns:

the JsonObject

Throws:

IfsException - if the operation fails.

getJsonString

public String getJsonString()
                     throws IfsException

Gets the JSON string representation of the search definition.

Returns:

the JSON string

Throws:

IfsException - if the operation fails.

getPreparedSelectorGenerator

public PreparedSelectorGenerator getPreparedSelectorGenerator()
                                                       throws IfsException

Gets the PreparedSelectorGenerator representation of the search definition.

Returns:

the PreparedSelectorGenerator

Throws:

IfsException - if the operation fails.

getPreparedSelector

public PreparedSelector getPreparedSelector()
                                     throws IfsException

Gets the PreparedSelector representation of the search definition.

Returns:

the PreparedSelector

Throws:

IfsException - if the operation fails.

setBindValues

public void setBindValues(AttributeValue[] bindValues)
                   throws IfsException

Sets the bind values.

Parameters:

bindValues - the bindValues

Throws:

IfsException - if the operation fails.

createPreparedSelectorGenerator

protected void createPreparedSelectorGenerator()
                                        throws IfsException

Creates the PreparedSelectorGenerator representation of the search definition.

Throws:

IfsException - if the operation fails.

getSearchTarget

protected AttributeValue getSearchTarget(AttributeValueTable targetTable)
                                  throws IfsException

Gets a search target from search target specification stored in an AttributeValueTable.

Parameters:

targetTable - the search target specification

Returns:

the search target

Throws:

IfsException - if the operation fails

getSearchTarget

protected AttributeValue getSearchTarget(String targetTag)
                                  throws IfsException

Gets a search target from search target specification.

Parameters:

target - the search target specification

Returns:

the search target

Throws:

IfsException - if the operation fails

getSearchTargets

protected AttributeValue[] getSearchTargets(String targetsTag)
                                     throws IfsException

Gets search Targets from a comma delimitted string defintion.

Parameters:

targetsTag - the comma delimitted string of targets.

Returns:

the array of search Targets

Throws:

IfsException - if the operation fails

getSearchTargets

protected AttributeValue[] getSearchTargets(String[] targetTags)
                                     throws IfsException

Gets search Targets from an array of target tags.

Parameters:

targetsTag - the comma delimitted string of targets.

Returns:

the array of search Targets

Throws:

IfsException - if the operation fails

getSearchTargets

protected AttributeValue[] getSearchTargets(List<AttributeValueTable> targetTables)
                                     throws IfsException

Gets search Targets from a list of target definition tables.

Parameters:

targetTables - the target definition tables.

Returns:

the array of search Targets

Throws:

IfsException - if the operation fails

getBindValues

protected AttributeValue[] getBindValues(List<AttributeValueTable> bindValueList)
                                  throws IfsException

Gets the bind values defined in the specified table list.

Parameters:

bindValueList - the table list that defines the bind values

Returns:

the array of bind values

Throws:

IfsException - if the operation fails