org.odpi.egeria.connectors.ibm.igc.clientlibrary.search

Class IGCSearch

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.search.IGCSearch

public class IGCSearch
extends Object

Manages the criteria to use for running a search against IGC.

Constructor Summary

Constructors

Constructor and Description
IGCSearch()
IGCSearch(List<String> types) Creates a new search for all assets of the provided types.
IGCSearch(List<String> types, IGCSearchConditionSet conditions) Creates a new search for all assets of the provided types, based on the provided criteria.
IGCSearch(String type) Creates a new search for all assets of the provided type.
IGCSearch(String type, IGCSearchConditionSet conditions) Creates a new search for assets of the provided type, based on the provided criteria.
IGCSearch(String type, List<String> properties, IGCSearchConditionSet conditions) Creates a new search for assets of the provided type, based on the provided criteria, retrieving all of the properties specified for each result.
IGCSearch(String type, String[] properties, IGCSearchConditionSet conditions) Creates a new search for assets of the provided type, based on the provided criteria, retrieving all of the properties specified for each result.

Method Summary

Modifier and Type	Method and Description
void	addConditions(IGCSearchConditionSet conditions) Adds a set of conditions to use for the search.
void	addProperties(List<String> properties) Add all properties provided by the array as ones to include in the search.
void	addProperty(String property) Add a property for which to search.
void	addSortingCriteria(IGCSearchSorting sortings) Adds the provided sorting criteria to use for the search.
void	addType(String type) Add an asset type for which to search.
com.fasterxml.jackson.databind.JsonNode	getQuery() Retrieves the query string for this search object.
void	setBeginAt(int beginAt) Set the number of results to skip over before returning (ie.
void	setDevGlossary(boolean on) Set whether to search the development glossary (true) or published glossary (false).
void	setPageSize(int size) Set the number of results to include in each page.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IGCSearch

public IGCSearch()

IGCSearch

public IGCSearch(String type)

Creates a new search for all assets of the provided type.

Parameters:

type - the type of assets to retrieve

IGCSearch

public IGCSearch(List<String> types)

Creates a new search for all assets of the provided types.

Parameters:

types - the types of assets to retrieve

IGCSearch

public IGCSearch(String type,
                 IGCSearchConditionSet conditions)

Creates a new search for assets of the provided type, based on the provided criteria.

Parameters:

type - the type of assets to retrieve

conditions - the set of conditions to use as search criteria

IGCSearch

public IGCSearch(List<String> types,
                 IGCSearchConditionSet conditions)

Creates a new search for all assets of the provided types, based on the provided criteria.

Parameters:

types - the types of assets to retrieve

conditions - the set of conditions to use as search criteria

IGCSearch

public IGCSearch(String type,
                 List<String> properties,
                 IGCSearchConditionSet conditions)

Creates a new search for assets of the provided type, based on the provided criteria, retrieving all of the properties specified for each result.

Parameters:

type - the type of assets to retrieve

properties - the properties to retrieve for each asset

conditions - the set of conditions to use as search criteria

IGCSearch

public IGCSearch(String type,
                 String[] properties,
                 IGCSearchConditionSet conditions)

Creates a new search for assets of the provided type, based on the provided criteria, retrieving all of the properties specified for each result.

Parameters:

type - the type of assets to retrieve

properties - the properties to retrieve for each asset

conditions - the set of conditions to use as search criteria

Method Detail

addType

public void addType(String type)

Add an asset type for which to search.

Parameters:

type - the name of the asset type to include in the search

addProperty

public void addProperty(String property)

Add a property for which to search.

Parameters:

property - the name of the property to include in the search

addProperties

public void addProperties(List<String> properties)

Add all properties provided by the array as ones to include in the search.

Parameters:

properties - the names of properties to include in the search

addConditions

public void addConditions(IGCSearchConditionSet conditions)

Adds a set of conditions to use for the search.

Parameters:

conditions - the set of conditions to add to the search criteria

addSortingCriteria

public void addSortingCriteria(IGCSearchSorting sortings)

Adds the provided sorting criteria to use for the search.

Parameters:

sortings - the criteria to use for sorting results

setPageSize

public void setPageSize(int size)

Set the number of results to include in each page.

Parameters:

size - the number of results to include in each page

setBeginAt

public void setBeginAt(int beginAt)

Set the number of results to skip over before returning (ie. for paging)

Parameters:

beginAt - the number at which to start returning results

setDevGlossary

public void setDevGlossary(boolean on)

Set whether to search the development glossary (true) or published glossary (false).

Parameters:

on - set to true to search the development glossary, or false (default) to search published

getQuery

public com.fasterxml.jackson.databind.JsonNode getQuery()

Retrieves the query string for this search object.

Returns:

JsonNode - the JSON structure representing the query string

toString

public String toString()

Overrides:

toString in class Object