How to use

hasPayloads

method

in

org.apache.lucene.index.Terms

@Override
public boolean hasPayloads() {
 return in.hasPayloads();
}

/** Sole constructor.
 *
 * @param subs The {@link Terms} instances of all sub-readers. 
 * @param subSlices A parallel array (matching {@code
 *        subs}) describing the sub-reader slices.
 */
public MultiTerms(Terms[] subs, ReaderSlice[] subSlices) throws IOException {
 this.subs = subs;
 this.subSlices = subSlices;
 
 assert subs.length > 0 : "inefficient: don't use MultiTerms over one sub";
 boolean _hasFreqs = true;
 boolean _hasOffsets = true;
 boolean _hasPositions = true;
 boolean _hasPayloads = false;
 for(int i=0;i<subs.length;i++) {
  _hasFreqs &= subs[i].hasFreqs();
  _hasOffsets &= subs[i].hasOffsets();
  _hasPositions &= subs[i].hasPositions();
  _hasPayloads |= subs[i].hasPayloads();
 }
 hasFreqs = _hasFreqs;
 hasOffsets = _hasOffsets;
 hasPositions = _hasPositions;
 hasPayloads = hasPositions && _hasPayloads; // if all subs have pos, and at least one has payloads.
}

final boolean hasPayloads = terms.hasPayloads();
final boolean hasOffsets = terms.hasOffsets();

final boolean postingsHasFreq = fieldInfo.getIndexOptions().compareTo(IndexOptions.DOCS_AND_FREQS) >= 0;
final boolean postingsHasPayload = fieldInfo.hasPayloads();
final boolean vectorsHasPayload = terms.hasPayloads();

final boolean hasPayloads = terms.hasPayloads();
assert !hasPayloads || hasPositions;

final boolean hasPayloads = terms.hasPayloads();
assert !hasPayloads || hasPositions;

@Override
public Query rewrite(IndexReader reader) throws IOException {
  Query rewritten = super.rewrite(reader);
  if (rewritten != this) {
    return rewritten;
  }
  boolean hasPayloads = false;
  for (LeafReaderContext context : reader.leaves()) {
    final Terms terms = context.reader().terms(term.field());
    if (terms != null) {
      if (terms.hasPayloads()) {
        hasPayloads = true;
        break;
      }
    }
  }
  // if the terms does not exist we could return a MatchNoDocsQuery but this would break the unified highlighter
  // which rewrites query with an empty reader.
  if (hasPayloads == false) {
    return new TermQuery(term);
  }
  return this;
}

private void initMemory(Terms curTerms, int termFreq) {
  // init memory for performance reasons
  if (curTerms.hasPositions()) {
    currentPositions = ArrayUtil.grow(currentPositions, termFreq);
  }
  if (curTerms.hasOffsets()) {
    currentStartOffset = ArrayUtil.grow(currentStartOffset, termFreq);
    currentEndOffset = ArrayUtil.grow(currentEndOffset, termFreq);
  }
  if (curTerms.hasPayloads()) {
    currentPayloads = new BytesArray[termFreq];
  }
}

private void buildValues(XContentBuilder builder, Terms curTerms, int termFreq) throws IOException {
  if (!(curTerms.hasPayloads() || curTerms.hasOffsets() || curTerms.hasPositions())) {
    return;
  }
  builder.startArray(FieldStrings.TOKENS);
  for (int i = 0; i < termFreq; i++) {
    builder.startObject();
    if (curTerms.hasPositions()) {
      builder.field(FieldStrings.POS, currentPositions[i]);
    }
    if (curTerms.hasOffsets()) {
      builder.field(FieldStrings.START_OFFSET, currentStartOffset[i]);
      builder.field(FieldStrings.END_OFFSET, currentEndOffset[i]);
    }
    if (curTerms.hasPayloads() && (currentPayloads[i].length() > 0)) {
      BytesRef bytesRef = currentPayloads[i].toBytesRef();
      builder.field(FieldStrings.PAYLOAD, bytesRef.bytes, bytesRef.offset, bytesRef.length);
    }
    builder.endObject();
  }
  builder.endArray();
}

private void initValues(Terms curTerms, PostingsEnum posEnum, int termFreq) throws IOException {
  for (int j = 0; j < termFreq; j++) {
    int nextPos = posEnum.nextPosition();
    if (curTerms.hasPositions()) {
      currentPositions[j] = nextPos;
    }
    if (curTerms.hasOffsets()) {
      currentStartOffset[j] = posEnum.startOffset();
      currentEndOffset[j] = posEnum.endOffset();
    }
    if (curTerms.hasPayloads()) {
      BytesRef curPayload = posEnum.getPayload();
      if (curPayload != null) {
        currentPayloads[j] = new BytesArray(curPayload.bytes, 0, curPayload.length);
      } else {
        currentPayloads[j] = null;
      }
    }
  }
}

@Override
public boolean hasPayloads() {
 return in.hasPayloads();
}

@Override
public boolean hasPayloads() {
 return in.hasPayloads();
}

@Override
public boolean hasPayloads() {
 return delegateTerms.hasPayloads();
}

@Override
public boolean hasPayloads() {
 return in.hasPayloads();
}

boolean positions = flags.contains(Flag.Positions) && fieldTermVector.hasPositions();
boolean offsets = flags.contains(Flag.Offsets) && fieldTermVector.hasOffsets();
boolean payloads = flags.contains(Flag.Payloads) && fieldTermVector.hasPayloads();

private void initMemory(Terms curTerms, int termFreq) {
  // init memory for performance reasons
  if (curTerms.hasPositions()) {
    currentPositions = ArrayUtil.grow(currentPositions, termFreq);
  }
  if (curTerms.hasOffsets()) {
    currentStartOffset = ArrayUtil.grow(currentStartOffset, termFreq);
    currentEndOffset = ArrayUtil.grow(currentEndOffset, termFreq);
  }
  if (curTerms.hasPayloads()) {
    currentPayloads = new BytesArray[termFreq];
  }
}

private void initMemory(Terms curTerms, int termFreq) {
  // init memory for performance reasons
  if (curTerms.hasPositions()) {
    currentPositions = ArrayUtil.grow(currentPositions, termFreq);
  }
  if (curTerms.hasOffsets()) {
    currentStartOffset = ArrayUtil.grow(currentStartOffset, termFreq);
    currentEndOffset = ArrayUtil.grow(currentEndOffset, termFreq);
  }
  if (curTerms.hasPayloads()) {
    currentPayloads = new BytesArray[termFreq];
  }
}

private void initMemory(Terms curTerms, int termFreq) {
  // init memory for performance reasons
  if (curTerms.hasPositions()) {
    currentPositions = ArrayUtil.grow(currentPositions, termFreq);
  }
  if (curTerms.hasOffsets()) {
    currentStartOffset = ArrayUtil.grow(currentStartOffset, termFreq);
    currentEndOffset = ArrayUtil.grow(currentEndOffset, termFreq);
  }
  if (curTerms.hasPayloads()) {
    currentPayloads = new BytesArray[termFreq];
  }
}

private void initMemory(Terms curTerms, int termFreq) {
  // init memory for performance reasons
  if (curTerms.hasPositions()) {
    currentPositions = ArrayUtil.grow(currentPositions, termFreq);
  }
  if (curTerms.hasOffsets()) {
    currentStartOffset = ArrayUtil.grow(currentStartOffset, termFreq);
    currentEndOffset = ArrayUtil.grow(currentEndOffset, termFreq);
  }
  if (curTerms.hasPayloads()) {
    currentPayloads = new BytesArray[termFreq];
  }
}

private void initValues(Terms curTerms, PostingsEnum posEnum, int termFreq) throws IOException {
  for (int j = 0; j < termFreq; j++) {
    int nextPos = posEnum.nextPosition();
    if (curTerms.hasPositions()) {
      currentPositions[j] = nextPos;
    }
    if (curTerms.hasOffsets()) {
      currentStartOffset[j] = posEnum.startOffset();
      currentEndOffset[j] = posEnum.endOffset();
    }
    if (curTerms.hasPayloads()) {
      BytesRef curPayload = posEnum.getPayload();
      if (curPayload != null) {
        currentPayloads[j] = new BytesArray(curPayload.bytes, 0, curPayload.length);
      } else {
        currentPayloads[j] = null;
      }
    }
  }
}