Package io.github.crew102.rapidrake

Class RakeAlgorithm

java.lang.Object

io.github.crew102.rapidrake.RakeAlgorithm

public class RakeAlgorithm
extends Object

The logic/implementation of the Rapid Automatic Keyword Extraction (RAKE) algorithm. The class's API includes:

• A constructor which sets the algorithm's parameters (stored in a RakeParams object) and specifies the POS tagging and sentence detection models
• The rake(java.lang.String) method, which runs RAKE on a string
• The getResult(java.util.ArrayList<io.github.crew102.rapidrake.model.Keyword>) method, which takes an array of Keyword objects and converts their relevant instance variables to primitive arrays

Author:

Chris Baker

Constructor Summary

Constructors

Constructor	Description
RakeAlgorithm(RakeParams rakeParams, InputStream taggerStream, InputStream sentDectStream)	Constructor.
RakeAlgorithm(RakeParams rakeParams, String taggerModelUrl, String sentDectModelUrl)	Constructor.

Method Summary

Modifier and Type	Method	Description
Result	getResult(ArrayList<Keyword> keywords)	Convert a list of keywords to a Result.
Result	rake(String txtEl)	Run RAKE on a single string.

Methods inherited from class java.lang.Object

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

Constructor Detail

RakeAlgorithm

public RakeAlgorithm(RakeParams rakeParams,
                     String taggerModelUrl,
                     String sentDectModelUrl)
              throws IOException

Constructor.

Parameters:

rakeParams - the parameters RAKE will use

taggerModelUrl - the URL of the trained POS tagging model

sentDectModelUrl - the URL of the trained sentence detection model

Throws:

IOException - if either of the URLs are invalid

See Also:

RakeParams

RakeAlgorithm

public RakeAlgorithm(RakeParams rakeParams,
                     InputStream taggerStream,
                     InputStream sentDectStream)
              throws IOException

Constructor.

Parameters:

rakeParams - the parameters RAKE will use

taggerStream - the input stream of the POS tagging model

sentDectStream - the input stream of the sentence detection model

Throws:

IOException - if either of the input streams are invalid

See Also:

RakeParams

Method Detail

rake

public Result rake(String txtEl)

Run RAKE on a single string.

Parameters:

txtEl - a string with the text that you want to run RAKE on

Returns:

a data object containing the results of RAKE

See Also:

Result

getResult

public Result getResult(ArrayList<Keyword> keywords)

Convert a list of keywords to a Result.

Parameters:

keywords - a list of extracted keywords

Returns:

a data object containing the results of RAKE

See Also:

Keyword, Result