DOKK / manpages / debian 12 / libkinosearch1-perl / KinoSearch1::Analysis::TokenBatch.3pm.en
KinoSearch1::Analysis::TokenBatch(3pm) User Contributed Perl Documentation KinoSearch1::Analysis::TokenBatch(3pm)

Add many tokens to the batch, by supplying the string to be tokenized, and arrays of token starts and token ends (specified in bytes).

KinoSearch1::Analysis::TokenBatch - a collection of tokens

    while ( $batch->next ) {
        $batch->set_text( lc( $batch->get_text ) );
    }

TokenBatch's API should be considered experimental and is likely to change.

A TokenBatch is a collection of Tokens which you can add to, then iterate over.

    my $batch = KinoSearch1::Analysis::TokenBatch->new;

Constructor.

    $batch->append( $text, $start_offset, $end_offset, $pos_inc );

Add a Token to the end of the batch. Accepts either three or four arguments: text, start_offset, end_offset, and an optional position increment which defaults to 1 if not supplied. For a description of what these arguments mean, see the docs for Token.

    while ( $batch->next ) {
        # ...
    }

Proceed to the next token in the TokenBatch. Returns true if the TokenBatch ends up located at valid token.

All of TokenBatch's accessor methods affect the current Token. Calling any of these methods when the TokenBatch is not located at a valid Token will trigger an exception.

Set/get the text of the current Token.

Set/get the start_offset of the current Token.

Set/get the end_offset of the current Token.

Set/get the position increment of the current Token.

Copyright 2005-2010 Marvin Humphrey

See KinoSearch1 version 1.01.

2022-10-20 perl v5.36.0