Package com.attivio.sdk.search

Interface SearchProfileApi

All Superinterfaces:

ExternalizableStore

public interface SearchProfileApi
extends ExternalizableStore

EXPERIMENTAL: This API will be changed/renamed in a future release.

Nested Class Summary

Nested classes/interfaces inherited from interface com.attivio.sdk.client.ExternalizableStore

ExternalizableStore.ImportOption

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STORE_NAME

Method Summary

Modifier and Type	Method	Description
void	compileSearchProfile(java.lang.String name)	Compile all outstanding changes to the search profile to support testing/publish.
void	createQueryFrame(java.lang.String searchProfile, QueryFrame frame)	Create a query frame.
void	createSearchProfile(SearchProfile profile)	Create a search profile.
default void	createSearchProfile(java.lang.String name)	Create a search profile.
void	deleteQueryFrame(java.lang.String searchProfile, java.lang.String name)	Delete a query frame.
void	deleteSearchProfile(java.lang.String name)	Delete a search profile identified by name.
void	exportSearchProfile(java.lang.String name, java.io.OutputStream output)	Export a search profile.
QueryFrame	getQueryFrame(java.lang.String searchProfile, java.lang.String name)	Get a query frame.
java.util.List<QueryFrame>	getQueryFrames(java.lang.String searchProfile)	Get a list of all query frames for searchProfile
SearchProfile	getSearchProfile(java.lang.String name)	Get search profile by name.
default java.util.List<java.lang.String>	getSearchProfileNames()	Return a list of the names of all search profiles.
java.util.List<SearchProfile>	getSearchProfiles()	Return a list of available search profiles.
default java.lang.String	getStoreName()	Get the name of this store.
default void	importSearchProfile(java.io.InputStream input)	Import search profile from input.
QueryFrameResult	process(QueryRequest request, java.lang.String query, java.lang.String workflow)	Get the matching query frame for a request.
void	publishSearchProfile(java.lang.String name)	Make the most recently compiled search profile live.
void	updateQueryFrame(java.lang.String searchProfile, QueryFrame frame)	Update query frame.
void	updateSearchProfile(SearchProfile profile)	Update a search profile.

Methods inherited from interface com.attivio.sdk.client.ExternalizableStore

exportStore, getStoreRevision, importStore

Field Detail

STORE_NAME

static final java.lang.String STORE_NAME

See Also:

Constant Field Values

Method Detail

getStoreName

default java.lang.String getStoreName()

Description copied from interface: ExternalizableStore

Get the name of this store.

This name will be the location that store configuration is synchronized to in the project's conf directory.

Specified by:

getStoreName in interface ExternalizableStore

createSearchProfile

default void createSearchProfile(java.lang.String name)
                          throws AttivioException

Create a search profile.

Throws:

AttivioException

createSearchProfile

void createSearchProfile(SearchProfile profile)
                  throws AttivioException

Create a search profile.

Throws:

AttivioException

updateSearchProfile

void updateSearchProfile(SearchProfile profile)
                  throws AttivioException

Update a search profile.

Throws:

AttivioException

deleteSearchProfile

void deleteSearchProfile(java.lang.String name)
                  throws AttivioException

Delete a search profile identified by name.

NOTE: this will delete all QueryFrames associated with this search profile.

Throws:

AttivioException

getSearchProfile

SearchProfile getSearchProfile(java.lang.String name)
                        throws AttivioException

Get search profile by name.

Throws:

AttivioException

getSearchProfiles

java.util.List<SearchProfile> getSearchProfiles()
                                         throws AttivioException

Return a list of available search profiles.

Throws:

AttivioException

getSearchProfileNames

default java.util.List<java.lang.String> getSearchProfileNames()
                                                        throws AttivioException

Return a list of the names of all search profiles.

Throws:

AttivioException

getQueryFrame

QueryFrame getQueryFrame(java.lang.String searchProfile,
                         java.lang.String name)
                  throws AttivioException

Get a query frame.

Throws:

AttivioException

createQueryFrame

void createQueryFrame(java.lang.String searchProfile,
                      QueryFrame frame)
               throws AttivioException

Create a query frame.

Throws:

AttivioException

updateQueryFrame

void updateQueryFrame(java.lang.String searchProfile,
                      QueryFrame frame)
               throws AttivioException

Update query frame.

Throws:

AttivioException

deleteQueryFrame

void deleteQueryFrame(java.lang.String searchProfile,
                      java.lang.String name)
               throws AttivioException

Delete a query frame.

Throws:

AttivioException

getQueryFrames

java.util.List<QueryFrame> getQueryFrames(java.lang.String searchProfile)
                                   throws AttivioException

Get a list of all query frames for searchProfile

Throws:

AttivioException

process

QueryFrameResult process(QueryRequest request,
                         java.lang.String query,
                         java.lang.String workflow)
                  throws AttivioException

Get the matching query frame for a request.

The request will specify the search profile to use.

This may represent multiple merged query frames.

Throws:

AttivioException

compileSearchProfile

void compileSearchProfile(java.lang.String name)
                   throws AttivioException

Compile all outstanding changes to the search profile to support testing/publish.

Throws:

AttivioException

publishSearchProfile

void publishSearchProfile(java.lang.String name)
                   throws AttivioException

Make the most recently compiled search profile live.

Throws:

AttivioException

exportSearchProfile

void exportSearchProfile(java.lang.String name,
                         java.io.OutputStream output)
                  throws AttivioException

Export a search profile.

Export will be a JAR file written to output.

Throws:

AttivioException

importSearchProfile

default void importSearchProfile(java.io.InputStream input)
                          throws AttivioException

Import search profile from input.

input must contain a JAR file containing the contents of a SearchProfile export.

Throws:

AttivioException