org.languagetool.rules.ml

Interface MLServerProto.MatchOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

MLServerProto.Match, MLServerProto.Match.Builder

Enclosing class:

MLServerProto

public static interface MLServerProto.MatchOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getId() prefix for rule ids; should use a common value for one model/server string id = 3;
com.google.protobuf.ByteString	getIdBytes() prefix for rule ids; should use a common value for one model/server string id = 3;
int	getLength() length of matched area; >0 uint32 length = 2;
String	getMatchDescription() description of the match; displayed in e.g. the add-on pop-up string matchDescription = 7;
com.google.protobuf.ByteString	getMatchDescriptionBytes() description of the match; displayed in e.g. the add-on pop-up string matchDescription = 7;
String	getMatchShortDescription() shortened description of the match; displayed in e.g.
com.google.protobuf.ByteString	getMatchShortDescriptionBytes() shortened description of the match; displayed in e.g.
int	getOffset() start position in the sentence (i.e. not relative to whole text) uint32 offset = 1;
String	getRuleDescription() added later, optional (can be substituted by Java) string ruleDescription = 6;
com.google.protobuf.ByteString	getRuleDescriptionBytes() added later, optional (can be substituted by Java) string ruleDescription = 6;
String	getSubId() more specific suffix for rule ids; i.e. one model/server can return multiple values to distinguish between mach types string sub_id = 4;
com.google.protobuf.ByteString	getSubIdBytes() more specific suffix for rule ids; i.e. one model/server can return multiple values to distinguish between mach types string sub_id = 4;
String	getSuggestions(int index) repeated string suggestions = 5;
com.google.protobuf.ByteString	getSuggestionsBytes(int index) repeated string suggestions = 5;
int	getSuggestionsCount() repeated string suggestions = 5;
List<String>	getSuggestionsList() repeated string suggestions = 5;

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getOffset

int getOffset()

 start position in the sentence (i.e. not relative to whole text)
 

uint32 offset = 1;

Returns:

The offset.

getLength

int getLength()

 length of matched area; >0
 

uint32 length = 2;

Returns:

The length.

getId

String getId()

 prefix for rule ids; should use a common value for one model/server
 

string id = 3;

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 prefix for rule ids; should use a common value for one model/server
 

string id = 3;

Returns:

The bytes for id.

getSubId

String getSubId()

 more specific suffix for rule ids; i.e. one model/server can return multiple values to distinguish between mach types
 

string sub_id = 4;

Returns:

The subId.

getSubIdBytes

com.google.protobuf.ByteString getSubIdBytes()

 more specific suffix for rule ids; i.e. one model/server can return multiple values to distinguish between mach types
 

string sub_id = 4;

Returns:

The bytes for subId.

getSuggestionsList

List<String> getSuggestionsList()

repeated string suggestions = 5;

Returns:

A list containing the suggestions.

getSuggestionsCount

int getSuggestionsCount()

repeated string suggestions = 5;

Returns:

The count of suggestions.

getSuggestions

String getSuggestions(int index)

repeated string suggestions = 5;

Parameters:

index - The index of the element to return.

Returns:

The suggestions at the given index.

getSuggestionsBytes

com.google.protobuf.ByteString getSuggestionsBytes(int index)

repeated string suggestions = 5;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the suggestions at the given index.

getRuleDescription

String getRuleDescription()

 added later, optional (can be substituted by Java)
 

string ruleDescription = 6;

Returns:

The ruleDescription.

getRuleDescriptionBytes

com.google.protobuf.ByteString getRuleDescriptionBytes()

 added later, optional (can be substituted by Java)
 

string ruleDescription = 6;

Returns:

The bytes for ruleDescription.

getMatchDescription

String getMatchDescription()

 description of the match; displayed in e.g. the add-on pop-up
 

string matchDescription = 7;

Returns:

The matchDescription.

getMatchDescriptionBytes

com.google.protobuf.ByteString getMatchDescriptionBytes()

 description of the match; displayed in e.g. the add-on pop-up
 

string matchDescription = 7;

Returns:

The bytes for matchDescription.

getMatchShortDescription

String getMatchShortDescription()

 shortened description of the match; displayed in e.g. LibreOffice context menu
 

string matchShortDescription = 8;

Returns:

The matchShortDescription.

getMatchShortDescriptionBytes

com.google.protobuf.ByteString getMatchShortDescriptionBytes()

 shortened description of the match; displayed in e.g. LibreOffice context menu
 

string matchShortDescription = 8;

Returns:

The bytes for matchShortDescription.