/AWS1/IF_SRH=>DEFINEANALYSISSCHEME()

About DefineAnalysisScheme

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Method Signature

METHODS /AWS1/IF_SRH~DEFINEANALYSISSCHEME
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/SRHDOMAINNAME OPTIONAL
    !IO_ANALYSISSCHEME TYPE REF TO /AWS1/CL_SRHANALYSISSCHEME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_srhdefinealyschemersp
  RAISING
    /AWS1/CX_SRHBASEEXCEPTION
    /AWS1/CX_SRHINTERNALEXCEPTION
    /AWS1/CX_SRHINVALIDTYPEEX
    /AWS1/CX_SRHLIMITEXCEEDEDEX
    /AWS1/CX_SRHRESOURCENOTFOUNDEX
    /AWS1/CX_SRHVALIDATIONEX
    /AWS1/CX_SRHCLIENTEXC
    /AWS1/CX_SRHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/SRHDOMAINNAME /AWS1/SRHDOMAINNAME

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

io_analysisscheme TYPE REF TO /AWS1/CL_SRHANALYSISSCHEME /AWS1/CL_SRHANALYSISSCHEME

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

RETURNING

oo_output TYPE REF TO /aws1/cl_srhdefinealyschemersp /AWS1/CL_SRHDEFINEALYSCHEMERSP

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->defineanalysisscheme(
  io_analysisscheme = new /aws1/cl_srhanalysisscheme(
    io_analysisoptions = new /aws1/cl_srhanalysisoptions(
      iv_algorithmicstemming = |string|
      iv_japanesetokizationdicti00 = |string|
      iv_stemmingdictionary = |string|
      iv_stopwords = |string|
      iv_synonyms = |string|
    )
    iv_analysisschemelanguage = |string|
    iv_analysisschemename = |string|
  )
  iv_domainname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_analysisschemestatus = lo_result->get_analysisscheme( ).
  IF lo_analysisschemestatus IS NOT INITIAL.
    lo_analysisscheme = lo_analysisschemestatus->get_options( ).
    IF lo_analysisscheme IS NOT INITIAL.
      lv_standardname = lo_analysisscheme->get_analysisschemename( ).
      lv_analysisschemelanguage = lo_analysisscheme->get_analysisschemelanguage( ).
      lo_analysisoptions = lo_analysisscheme->get_analysisoptions( ).
      IF lo_analysisoptions IS NOT INITIAL.
        lv_string = lo_analysisoptions->get_synonyms( ).
        lv_string = lo_analysisoptions->get_stopwords( ).
        lv_string = lo_analysisoptions->get_stemmingdictionary( ).
        lv_string = lo_analysisoptions->get_japanesetokizationdict00( ).
        lv_algorithmicstemming = lo_analysisoptions->get_algorithmicstemming( ).
      ENDIF.
    ENDIF.
    lo_optionstatus = lo_analysisschemestatus->get_status( ).
    IF lo_optionstatus IS NOT INITIAL.
      lv_updatetimestamp = lo_optionstatus->get_creationdate( ).
      lv_updatetimestamp = lo_optionstatus->get_updatedate( ).
      lv_uintvalue = lo_optionstatus->get_updateversion( ).
      lv_optionstate = lo_optionstatus->get_state( ).
      lv_boolean = lo_optionstatus->get_pendingdeletion( ).
    ENDIF.
  ENDIF.
ENDIF.