当前位置: 首页 > 文档资料 > Lucene 中文文档 >

Token

优质
小牛编辑
132浏览
2023-12-01

令牌表示文档中的文本或单词,其中包含相关详细信息,如元数据(位置,起始偏移,结束偏移,标记类型及其位置增量)。

Class 声明 (Class Declaration)

以下是org.apache.lucene.analysis.Token类的声明:

public class Token
   extends TermAttributeImpl
      implements TypeAttribute, PositionIncrementAttribute, 
         FlagsAttribute, OffsetAttribute, 
         PayloadAttribute, PositionLengthAttribute

字段 (Fields)

以下是org.apache.lucene.analysis.Token类的字段 -

  • static AttributeSource.AttributeFactory TOKEN_ATTRIBUTE_FACTORY - 将Token作为基本属性的实现返回并返回所有其他属性的默认impl(附加“Impl”)的便捷工厂。

类构造函数 (Class Constructors)

下表显示了不同的类构造函数 -

S.No.构造函数和描述
1

Token()

构造一个Token将为null文本。

2

Token(char[] startTermBuffer, int termBufferOffset, int termBufferLength, int start, int end)

使用给定的术语缓冲区(偏移量和长度),开始和结束偏移构造一个令牌

3

Token(int start, int end)

构造具有空文本和开始和结束偏移的令牌。

4

Constructs a Token with null text and start & end offsets plus flags.

5

Constructs a Token with null text and start/ end offsets plus the Token type.

6

Token(String text, int start, int end)

使用给定的术语文本和开始/结束偏移构造一个令牌。

7

Token(String text, int start, int end, int flags)

使用给定文本,开始/结束偏移和类型构造令牌。

8

Token(String text, int start, int end, String typ)

使用给定文本,开始/结束偏移和类型构造令牌。

Class Methods

下表显示了不同的类方法 -

S.No.方法和描述
1

void clear()

将术语text,payload,flags和positionIncrement,startOffset,endOffset和token类型重置为默认值。

2

Object clone()

这是一个浅层克隆。

3

Token clone(char[] newTermBuffer, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset)

制作克隆,但替换过程中的术语缓冲区和开始/结束偏移。

4

void copyTo(AttributeImpl target)

将此Attribute中的值复制到传入的target属性中。

5

int endOffset()

返回令牌的结束偏移量; 一个大于源文本中与此标记对应的最后一个字符的位置。

6

boolean equals(Object obj)

7

int getFlags()

获取已设置的任何位的bitset。

8

Payload getPayload()

返回此Token的有效负载。

9

int getPositionIncrement()

返回此令牌的位置增量。

10

int getPositionLength()

获得位置长度。

11

int hashCode()

12

void reflectWith(AttributeReflector reflector)

此方法用于内省属性,它应该简单地将此属性保存的键/值添加到给定的AttributeReflector。

13

Token reinit(char[] newTermBuffer, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset)

在Token.DEFAULT_TYPE上调用clear(),CharTermAttributeImpl.copyBuffer(char [],int,int),setStartOffset(int),setEndOffset(int)setType(java.lang.String)的简写

14

Token reinit(char[] newTermBuffer, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset, String newType)

调用clear(),CharTermAttributeImpl.copyBuffer(char [],int,int),setStartOffset(int),setEndOffset(int),setType(java.lang.String)的简写

15

Token reinit(String newTerm, int newStartOffset, int newEndOffset)

在Token.DEFAULT_TYPE上调用clear(),CharTermAttributeImpl.append(CharSequence),setStartOffset(int),setEndOffset(int)setType(java.lang.String)的简写

16

Token reinit(String newTerm, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset)

在Token.DEFAULT_TYPE上调用clear(),CharTermAttributeImpl.append(CharSequence,int,int),setStartOffset(int),setEndOffset(int)setType(java.lang.String)的简写

17

Token reinit(String newTerm, int newTermOffset, int newTermLength, int newStartOffset, int newEndOffset, String newType)

调用clear(),CharTermAttributeImpl.append(CharSequence,int,int),setStartOffset(int),setEndOffset(int)setType(java.lang.String)的简写

18

Token reinit(String newTerm, int newStartOffset, int newEndOffset, String newType)

调用clear(),CharTermAttributeImpl.append(CharSequence),setStartOffset(int),setEndOffset(int)setType(java.lang.String)的简写

19

void reinit(Token prototype)

将原型令牌的字段复制到此字段中。

20

void reinit(Token prototype, char[] newTermBuffer, int offset, int length)

将原型令牌的字段复制到此字段中,并使用不同的术语。

21

void reinit(Token prototype, String newTerm)

将原型令牌的字段复制到此字段中,并使用不同的术语。

22

void setEndOffset(int offset)

设置结束偏移量。

23

void setFlags(int flags)

24

void setOffset(int startOffset, int endOffset)

设置起始和结束偏移量。

25

void setPayload(Payload payload)

设置此令牌的有效负载。

26

void setPositionIncrement(int positionIncrement)

设置位置增量。

27

void setPositionLength(int positionLength)

设置位置长度。

28

void setStartOffset(int offset)

设置起始偏移量。

29

void setType(String type)

设置词法类型。

30

int startOffset()

返回此标记的起始偏移量,即源文本中与此标记对应的第一个字符的位置。

31

String type()

返回此Token的词法类型。

方法继承 (Methods Inherited)

该类继承以下类中的方法 -

  • org.apache.lucene.analysis.tokenattributes.TermAttributeImpl
  • org.apache.lucene.analysis.tokenattributes.CharTermAttributeImpl
  • org.apache.lucene.util.AttributeImpl
  • java.lang.Object