Uses of Class
org.apache.lucene.util.BytesRef

Packages that use BytesRef
org.apache.lucene.analysis API and code to convert text into indexable/searchable tokens. 
org.apache.lucene.analysis.tokenattributes General-purpose attributes for text analysis. 
org.apache.lucene.codecs Codecs API: API for customization of the encoding and structure of the index. 
org.apache.lucene.codecs.lucene40 Lucene 4.0 file format. 
org.apache.lucene.codecs.lucene40.values Default DocValues implementation for Lucene 4.0 indexes. 
org.apache.lucene.codecs.memory Postings format that is read entirely into memory. 
org.apache.lucene.codecs.pulsing Pulsing Codec: inlines low frequency terms' postings into terms dictionary. 
org.apache.lucene.codecs.sep Sep: base support for separate files (doc,frq,pos,skp,pyl) 
org.apache.lucene.codecs.simpletext Simpletext Codec: writes human readable postings. 
org.apache.lucene.document The logical representation of a Document for indexing and searching. 
org.apache.lucene.index Code to maintain and access indices. 
org.apache.lucene.search Code to search indices. 
org.apache.lucene.search.payloads The payloads package provides Query mechanisms for finding and using payloads. 
org.apache.lucene.search.similarities This package contains the various ranking models that can be used in Lucene. 
org.apache.lucene.util Some utility classes. 
org.apache.lucene.util.automaton Finite-state automaton for regular expressions. 
org.apache.lucene.util.fst Finite state transducers 
org.apache.lucene.util.hash Hashing functions load-able via SPI service 
org.apache.lucene.util.mutable Comparable object wrappers 
 

Uses of BytesRef in org.apache.lucene.analysis
 

Methods in org.apache.lucene.analysis that return BytesRef
 BytesRef NumericTokenStream.NumericTermAttributeImpl.getBytesRef()
           
 BytesRef Token.getPayload()
          Returns this Token's payload.
 

Methods in org.apache.lucene.analysis with parameters of type BytesRef
 void Token.setPayload(BytesRef payload)
          Sets this Token's payload.
 

Uses of BytesRef in org.apache.lucene.analysis.tokenattributes
 

Methods in org.apache.lucene.analysis.tokenattributes that return BytesRef
 BytesRef CharTermAttributeImpl.getBytesRef()
           
 BytesRef TermToBytesRefAttribute.getBytesRef()
          Retrieve this attribute's BytesRef.
 BytesRef PayloadAttributeImpl.getPayload()
          Returns this Token's payload.
 BytesRef PayloadAttribute.getPayload()
          Returns this Token's payload.
 

Methods in org.apache.lucene.analysis.tokenattributes with parameters of type BytesRef
 void PayloadAttributeImpl.setPayload(BytesRef payload)
          Sets this Token's payload.
 void PayloadAttribute.setPayload(BytesRef payload)
          Sets this Token's payload.
 

Constructors in org.apache.lucene.analysis.tokenattributes with parameters of type BytesRef
PayloadAttributeImpl(BytesRef payload)
          Initialize this attribute with the given payload.
 

Uses of BytesRef in org.apache.lucene.codecs
 

Fields in org.apache.lucene.codecs declared as BytesRef
protected  BytesRef DocValuesConsumer.spare
           
 

Methods in org.apache.lucene.codecs that return BytesRef
abstract  BytesRef DocValuesArraySource.getBytes(int docID, BytesRef ref)
           
 BytesRef MappingMultiDocsAndPositionsEnum.getPayload()
           
abstract  BytesRef TermsIndexReaderBase.FieldIndexEnum.term()
           
 

Methods in org.apache.lucene.codecs that return types with arguments of type BytesRef
 Comparator<BytesRef> BlockTreeTermsReader.FieldReader.getComparator()
           
abstract  Comparator<BytesRef> TermsConsumer.getComparator()
          Return the BytesRef Comparator used to sort terms before feeding to this API.
abstract  Comparator<BytesRef> TermVectorsWriter.getComparator()
          Return the BytesRef Comparator used to sort terms before feeding to this API.
 Comparator<BytesRef> PerDocProducerBase.getComparator()
           
 

Methods in org.apache.lucene.codecs with parameters of type BytesRef
abstract  void TermsIndexWriterBase.FieldWriter.add(BytesRef text, TermStats stats, long termsFilePointer)
           
abstract  void PostingsConsumer.addPosition(int position, BytesRef payload, int startOffset, int endOffset)
          Add a new position & payload, and start/end offset.
static int DocValuesArraySource.asInt(BytesRef b)
          Converts 4 consecutive bytes from the current offset to an int.
static long DocValuesArraySource.asLong(BytesRef b)
          Converts 8 consecutive bytes from the current offset to a long.
static short DocValuesArraySource.asShort(BytesRef b)
          Converts 2 consecutive bytes from the current offset to a short.
abstract  boolean TermsIndexWriterBase.FieldWriter.checkIndexTerm(BytesRef text, TermStats stats)
           
static void DocValuesArraySource.copyInt(BytesRef ref, int value)
          Copies the given int value and encodes it as 4 byte Big-Endian.
static void DocValuesArraySource.copyLong(BytesRef ref, long value)
          Copies the given long value and encodes it as 8 byte Big-Endian.
static void DocValuesArraySource.copyShort(BytesRef ref, short value)
          Copies the given short value and encodes it as a 2 byte Big-Endian.
abstract  void TermsConsumer.finishTerm(BytesRef text, TermStats stats)
          Finishes the current term; numDocs must be > 0.
abstract  BytesRef DocValuesArraySource.getBytes(int docID, BytesRef ref)
           
protected  int VariableGapTermsIndexWriter.indexedTermPrefixLength(BytesRef priorTerm, BytesRef indexedTerm)
          NOTE: if your codec does not sort in unicode code point order, you must override this method, to simply return indexedTerm.length.
protected  int FixedGapTermsIndexWriter.indexedTermPrefixLength(BytesRef priorTerm, BytesRef indexedTerm)
          NOTE: if your codec does not sort in unicode code point order, you must override this method, to simply return indexedTerm.length.
 TermsEnum BlockTreeTermsReader.FieldReader.intersect(CompiledAutomaton compiled, BytesRef startTerm)
           
abstract  boolean VariableGapTermsIndexWriter.IndexTermSelector.isIndexTerm(BytesRef term, TermStats stats)
          Called sequentially on every term being written, returning true if this term should be indexed
 boolean VariableGapTermsIndexWriter.EveryNTermSelector.isIndexTerm(BytesRef term, TermStats stats)
           
 boolean VariableGapTermsIndexWriter.EveryNOrDocFreqTermSelector.isIndexTerm(BytesRef term, TermStats stats)
           
abstract  long TermsIndexReaderBase.FieldIndexEnum.seek(BytesRef term)
          Seeks to "largest" indexed term that's <= term; returns file pointer index (into the main terms index file) for that term
abstract  PostingsConsumer TermsConsumer.startTerm(BytesRef text)
          Starts a new term in this field; this may be called with no corresponding call to finish if the term had no docs.
abstract  void TermVectorsWriter.startTerm(BytesRef term, int freq)
          Adds a term and its term frequency freq.
 void DocValuesArraySource.toBytes(double value, BytesRef bytesRef)
           
 void DocValuesArraySource.toBytes(long value, BytesRef bytesRef)
           
 

Constructor parameters in org.apache.lucene.codecs with type arguments of type BytesRef
FixedGapTermsIndexReader(Directory dir, FieldInfos fieldInfos, String segment, int indexDivisor, Comparator<BytesRef> termComp, String segmentSuffix, IOContext context)
           
 

Uses of BytesRef in org.apache.lucene.codecs.lucene40
 

Methods in org.apache.lucene.codecs.lucene40 that return types with arguments of type BytesRef
 Comparator<BytesRef> Lucene40TermVectorsWriter.getComparator()
           
 

Methods in org.apache.lucene.codecs.lucene40 with parameters of type BytesRef
 void Lucene40PostingsWriter.addPosition(int position, BytesRef payload, int startOffset, int endOffset)
          Add a new position & payload
 void Lucene40TermVectorsWriter.startTerm(BytesRef term, int freq)
           
 

Uses of BytesRef in org.apache.lucene.codecs.lucene40.values
 

Methods in org.apache.lucene.codecs.lucene40.values that return types with arguments of type BytesRef
 Comparator<BytesRef> DocValuesWriterBase.getComparator()
           
 

Method parameters in org.apache.lucene.codecs.lucene40.values with type arguments of type BytesRef
static DocValues Bytes.getValues(Directory dir, String id, Bytes.Mode mode, boolean fixedSize, int maxDoc, Comparator<BytesRef> sortComparator, IOContext context)
          Creates a new DocValues instance that provides either memory resident or iterative access to a per-document stored byte[] value.
static DocValuesConsumer Bytes.getWriter(Directory dir, String id, Bytes.Mode mode, boolean fixedSize, Comparator<BytesRef> sortComparator, Counter bytesUsed, IOContext context, float acceptableOverheadRatio)
          Creates a new byte[] Writer instances for the given directory.
 

Uses of BytesRef in org.apache.lucene.codecs.memory
 

Methods in org.apache.lucene.codecs.memory that return BytesRef
 BytesRef DirectPostingsFormat.HighFreqDocsAndPositionsEnum.getPayload()
           
 

Uses of BytesRef in org.apache.lucene.codecs.pulsing
 

Methods in org.apache.lucene.codecs.pulsing with parameters of type BytesRef
 void PulsingPostingsWriter.addPosition(int position, BytesRef payload, int startOffset, int endOffset)
           
 

Uses of BytesRef in org.apache.lucene.codecs.sep
 

Methods in org.apache.lucene.codecs.sep with parameters of type BytesRef
 void SepPostingsWriter.addPosition(int position, BytesRef payload, int startOffset, int endOffset)
          Add a new position & payload
 

Uses of BytesRef in org.apache.lucene.codecs.simpletext
 

Fields in org.apache.lucene.codecs.simpletext declared as BytesRef
protected  BytesRef SimpleTextDocValuesConsumer.scratch
           
 

Methods in org.apache.lucene.codecs.simpletext that return BytesRef
protected  BytesRef SimpleTextDocValuesConsumer.getHeader()
           
 

Methods in org.apache.lucene.codecs.simpletext that return types with arguments of type BytesRef
 Comparator<BytesRef> SimpleTextTermVectorsWriter.getComparator()
           
 

Methods in org.apache.lucene.codecs.simpletext with parameters of type BytesRef
static String SimpleTextPerDocProducer.readString(int offset, BytesRef scratch)
           
 void SimpleTextTermVectorsWriter.startTerm(BytesRef term, int freq)
           
protected  void SimpleTextDocValuesConsumer.writeDoc(IndexOutput output, int docId, BytesRef spare)
           
 

Constructor parameters in org.apache.lucene.codecs.simpletext with type arguments of type BytesRef
SimpleTextNormsFormat.SimpleTextNormsPerDocProducer(SegmentReadState state, Comparator<BytesRef> comp)
           
SimpleTextPerDocProducer(SegmentReadState state, Comparator<BytesRef> comp, String segmentSuffix)
          Creates a new SimpleTextPerDocProducer instance and loads all DocValues instances for this segment and codec.
 

Uses of BytesRef in org.apache.lucene.document
 

Methods in org.apache.lucene.document that return BytesRef
 BytesRef Field.binaryValue()
           
 BytesRef Document.getBinaryValue(String name)
          Returns an array of bytes for the first (or only) field that has the name specified as the method parameter.
 BytesRef[] Document.getBinaryValues(String name)
          Returns an array of byte arrays for of the fields that have the name specified as the method parameter.
 

Methods in org.apache.lucene.document with parameters of type BytesRef
static byte[] CompressionTools.decompress(BytesRef bytes)
           
static String CompressionTools.decompressString(BytesRef bytes)
           
 void Field.setBytesValue(BytesRef value)
          Expert: change the value of this field.
 

Constructors in org.apache.lucene.document with parameters of type BytesRef
DerefBytesDocValuesField(String name, BytesRef bytes)
           
DerefBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength)
           
Field(String name, BytesRef bytes, FieldType type)
          Create field with binary value.
SortedBytesDocValuesField(String name, BytesRef bytes)
           
SortedBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength)
           
StoredField(String name, BytesRef value)
           
StraightBytesDocValuesField(String name, BytesRef bytes)
           
StraightBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength)
           
 

Uses of BytesRef in org.apache.lucene.index
 

Fields in org.apache.lucene.index declared as BytesRef
protected  BytesRef[] DocTermOrds.indexedTermsArray
           
protected  BytesRef DocTermOrds.prefix
           
 

Methods in org.apache.lucene.index that return BytesRef
 BytesRef IndexableField.binaryValue()
          Non-null if this field has a binary value
 BytesRef Term.bytes()
          Returns the bytes of this term.
abstract  BytesRef DocValues.SortedSource.getByOrd(int ord, BytesRef result)
          Returns value for specified ord.
 BytesRef DocValues.Source.getBytes(int docID, BytesRef ref)
          Returns a BytesRef for the given document id or throws an UnsupportedOperationException if this source doesn't support byte[] values.
 BytesRef DocValues.SortedSource.getBytes(int docID, BytesRef bytesRef)
           
 BytesRef FilterAtomicReader.FilterDocsAndPositionsEnum.getPayload()
           
 BytesRef MultiDocsAndPositionsEnum.getPayload()
           
abstract  BytesRef DocsAndPositionsEnum.getPayload()
          Returns the payload at this position, or null if no payload was indexed.
 BytesRef Norm.getSpare()
          Returns a spare BytesRef
 BytesRef DocTermOrds.lookupTerm(TermsEnum termsEnum, int ord)
           
 BytesRef FilterAtomicReader.FilterTermsEnum.next()
           
 BytesRef MultiTermsEnum.next()
           
 BytesRef FilteredTermsEnum.next()
           
protected  BytesRef FilteredTermsEnum.nextSeekTerm(BytesRef currentTerm)
          On the first call to FilteredTermsEnum.next() or if FilteredTermsEnum.accept(org.apache.lucene.util.BytesRef) returns FilteredTermsEnum.AcceptStatus.YES_AND_SEEK or FilteredTermsEnum.AcceptStatus.NO_AND_SEEK, this method will be called to eventually seek the underlying TermsEnum to a new position.
abstract  BytesRef TermsEnum.term()
          Returns current term.
 BytesRef FilterAtomicReader.FilterTermsEnum.term()
           
 BytesRef MultiTermsEnum.term()
           
 BytesRef FilteredTermsEnum.term()
           
 

Methods in org.apache.lucene.index that return types with arguments of type BytesRef
 Comparator<BytesRef> DocValues.SortedSource.getComparator()
          Returns the comparator used to order the BytesRefs.
abstract  Comparator<BytesRef> Terms.getComparator()
          Return the BytesRef Comparator used to sort terms provided by the iterator.
 Comparator<BytesRef> FilterAtomicReader.FilterTerms.getComparator()
           
 Comparator<BytesRef> FilterAtomicReader.FilterTermsEnum.getComparator()
           
 Comparator<BytesRef> MultiTermsEnum.getComparator()
           
 Comparator<BytesRef> MultiTerms.getComparator()
           
 Comparator<BytesRef> FilteredTermsEnum.getComparator()
           
 

Methods in org.apache.lucene.index with parameters of type BytesRef
protected  FilteredTermsEnum.AcceptStatus SingleTermsEnum.accept(BytesRef term)
           
protected abstract  FilteredTermsEnum.AcceptStatus FilteredTermsEnum.accept(BytesRef term)
          Return if term is accepted, not accepted or the iteration should ended (and possibly seek).
 void SortedBytesMergeUtils.BytesRefConsumer.consume(BytesRef ref, int ord, long offset)
           
 void SortedBytesMergeUtils.IndexOutputBytesRefConsumer.consume(BytesRef currentMergedBytes, int ord, long offset)
           
abstract  int IndexReader.docFreq(String field, BytesRef term)
          Returns the number of documents containing the term.
 int AtomicReader.docFreq(String field, BytesRef term)
           
 int BaseCompositeReader.docFreq(String field, BytesRef t)
           
abstract  BytesRef DocValues.SortedSource.getByOrd(int ord, BytesRef result)
          Returns value for specified ord.
 BytesRef DocValues.Source.getBytes(int docID, BytesRef ref)
          Returns a BytesRef for the given document id or throws an UnsupportedOperationException if this source doesn't support byte[] values.
 BytesRef DocValues.SortedSource.getBytes(int docID, BytesRef bytesRef)
           
 int DocValues.SortedSource.getOrdByValue(BytesRef value, BytesRef spare)
          Lookup ord by value.
abstract  PayloadProcessorProvider.PayloadProcessor PayloadProcessorProvider.ReaderPayloadProcessor.getProcessor(String field, BytesRef text)
          Returns a PayloadProcessorProvider.ReaderPayloadProcessor for the given term.
static DocsEnum MultiFields.getTermDocsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term)
          Returns DocsEnum for the specified field & term.
static DocsEnum MultiFields.getTermDocsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term, int flags)
          Returns DocsEnum for the specified field & term, with control over whether freqs are required.
static DocsAndPositionsEnum MultiFields.getTermPositionsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term)
          Returns DocsAndPositionsEnum for the specified field & term.
static DocsAndPositionsEnum MultiFields.getTermPositionsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term, int flags)
          Returns DocsAndPositionsEnum for the specified field & term, with control over whether offsets and payloads are required.
 TermsEnum Terms.intersect(CompiledAutomaton compiled, BytesRef startTerm)
          Returns a TermsEnum that iterates over all terms that are accepted by the provided CompiledAutomaton.
 TermsEnum FilterAtomicReader.FilterTerms.intersect(CompiledAutomaton automaton, BytesRef bytes)
           
 TermsEnum MultiTerms.intersect(CompiledAutomaton compiled, BytesRef startTerm)
           
protected  BytesRef FilteredTermsEnum.nextSeekTerm(BytesRef currentTerm)
          On the first call to FilteredTermsEnum.next() or if FilteredTermsEnum.accept(org.apache.lucene.util.BytesRef) returns FilteredTermsEnum.AcceptStatus.YES_AND_SEEK or FilteredTermsEnum.AcceptStatus.NO_AND_SEEK, this method will be called to eventually seek the underlying TermsEnum to a new position.
abstract  void PayloadProcessorProvider.PayloadProcessor.processPayload(BytesRef payload)
          Process the incoming payload and stores the result in the given BytesRef.
 TermsEnum.SeekStatus TermsEnum.seekCeil(BytesRef text)
          Seeks to the specified term, if it exists, or to the next (ceiling) term.
abstract  TermsEnum.SeekStatus TermsEnum.seekCeil(BytesRef text, boolean useCache)
          Expert: just like TermsEnum.seekCeil(BytesRef) but allows you to control whether the implementation should attempt to use its term cache (if it uses one).
 TermsEnum.SeekStatus FilterAtomicReader.FilterTermsEnum.seekCeil(BytesRef text, boolean useCache)
           
 TermsEnum.SeekStatus MultiTermsEnum.seekCeil(BytesRef term, boolean useCache)
           
 TermsEnum.SeekStatus FilteredTermsEnum.seekCeil(BytesRef term, boolean useCache)
          This enum does not support seeking!
 boolean TermsEnum.seekExact(BytesRef text, boolean useCache)
          Attempts to seek to the exact term, returning true if the term is found.
 boolean FilterAtomicReader.FilterTermsEnum.seekExact(BytesRef text, boolean useCache)
           
 boolean MultiTermsEnum.seekExact(BytesRef term, boolean useCache)
           
 boolean FilteredTermsEnum.seekExact(BytesRef term, boolean useCache)
          This enum does not support seeking!
 void TermsEnum.seekExact(BytesRef term, TermState state)
          Expert: Seeks a specific position by TermState previously obtained from TermsEnum.termState().
 void FilterAtomicReader.FilterTermsEnum.seekExact(BytesRef term, TermState state)
           
 void FilteredTermsEnum.seekExact(BytesRef term, TermState state)
          This enum does not support seeking!
 void Norm.setBytes(BytesRef norm)
          Sets a fixed byte array norm value
protected  void FilteredTermsEnum.setInitialSeekTerm(BytesRef term)
          Use this method to set the initial BytesRef to seek before iterating.
 DocsEnum AtomicReader.termDocsEnum(Bits liveDocs, String field, BytesRef term)
          Returns DocsEnum for the specified field & term.
 DocsEnum AtomicReader.termDocsEnum(Bits liveDocs, String field, BytesRef term, int flags)
          Returns DocsEnum for the specified field & term, with control over whether freqs are required.
 DocsAndPositionsEnum AtomicReader.termPositionsEnum(Bits liveDocs, String field, BytesRef term)
          Returns DocsAndPositionsEnum for the specified field & term.
 DocsAndPositionsEnum AtomicReader.termPositionsEnum(Bits liveDocs, String field, BytesRef term, int flags)
          Returns DocsAndPositionsEnum for the specified field & term, with control over whether offsets and payloads are required.
static long MultiFields.totalTermFreq(IndexReader r, String field, BytesRef text)
           
 long AtomicReader.totalTermFreq(String field, BytesRef term)
          Returns the number of documents containing the term t.
protected  void DocTermOrds.uninvert(AtomicReader reader, BytesRef termPrefix)
           
 

Method parameters in org.apache.lucene.index with type arguments of type BytesRef
static SortedBytesMergeUtils.MergeContext SortedBytesMergeUtils.init(DocValues.Type type, DocValues[] docValues, Comparator<BytesRef> comp, int mergeDocCount)
           
 

Constructors in org.apache.lucene.index with parameters of type BytesRef
DocTermOrds(AtomicReader reader, String field, BytesRef termPrefix)
          Inverts only terms starting w/ prefix
DocTermOrds(AtomicReader reader, String field, BytesRef termPrefix, int maxTermDocFreq)
          Inverts only terms starting w/ prefix, and only terms whose docFreq (not taking deletions into account) is <= maxTermDocFreq
DocTermOrds(AtomicReader reader, String field, BytesRef termPrefix, int maxTermDocFreq, int indexIntervalBits)
          Inverts only terms starting w/ prefix, and only terms whose docFreq (not taking deletions into account) is <= maxTermDocFreq, with a custom indexing interval (default is every 128nd term).
SingleTermsEnum(TermsEnum tenum, BytesRef termText)
          Creates a new SingleTermsEnum.
Term(String fld, BytesRef bytes)
          Constructs a Term with the given field and bytes.
 

Constructor parameters in org.apache.lucene.index with type arguments of type BytesRef
DocValues.SortedSource(DocValues.Type type, Comparator<BytesRef> comparator)
           
SortedBytesMergeUtils.MergeContext(Comparator<BytesRef> comp, int mergeDocCount, int size, DocValues.Type type)
           
 

Uses of BytesRef in org.apache.lucene.search
 

Methods in org.apache.lucene.search that return BytesRef
 BytesRef MaxNonCompetitiveBoostAttributeImpl.getCompetitiveTerm()
           
 BytesRef MaxNonCompetitiveBoostAttribute.getCompetitiveTerm()
          This is the term or null of the term that triggered the boost change.
 BytesRef TermRangeQuery.getLowerTerm()
          Returns the lower value of this range query
 BytesRef TermRangeFilter.getLowerTerm()
          Returns the lower value of this range filter
abstract  BytesRef FieldCache.DocTerms.getTerm(int docID, BytesRef ret)
          The BytesRef argument must not be null; the method returns the same BytesRef, or an empty (length=0) BytesRef if the doc did not have this field or was deleted.
 BytesRef FieldCache.DocTermsIndex.getTerm(int docID, BytesRef reuse)
          Convenience method, to lookup the Term for a doc.
 BytesRef TermRangeQuery.getUpperTerm()
          Returns the upper value of this range query
 BytesRef TermRangeFilter.getUpperTerm()
          Returns the upper value of this range filter
abstract  BytesRef FieldCache.DocTermsIndex.lookup(int ord, BytesRef reuse)
          The BytesRef argument must not be null; the method returns the same BytesRef, or an empty (length=0) BytesRef if this ord is the null ord (0).
 BytesRef FuzzyTermsEnum.next()
           
 BytesRef FuzzyTermsEnum.term()
           
 BytesRef TermStatistics.term()
          returns the term text
 BytesRef FieldComparator.TermOrdValComparator.value(int slot)
           
 BytesRef FieldComparator.TermOrdValDocValuesComparator.value(int slot)
           
 BytesRef FieldComparator.TermValComparator.value(int slot)
           
 BytesRef FieldComparator.TermValDocValuesComparator.value(int slot)
           
 

Methods in org.apache.lucene.search that return types with arguments of type BytesRef
 Comparator<BytesRef> SortField.getBytesComparator()
           
 Comparator<BytesRef> FuzzyTermsEnum.getComparator()
           
 FieldComparator<BytesRef> FieldComparator.TermOrdValComparator.setNextReader(AtomicReaderContext context)
           
 FieldComparator<BytesRef> FieldComparator.TermOrdValDocValuesComparator.setNextReader(AtomicReaderContext context)
           
 FieldComparator<BytesRef> FieldComparator.TermValComparator.setNextReader(AtomicReaderContext context)
           
 FieldComparator<BytesRef> FieldComparator.TermValDocValuesComparator.setNextReader(AtomicReaderContext context)
           
 

Methods in org.apache.lucene.search with parameters of type BytesRef
protected  FilteredTermsEnum.AcceptStatus PrefixTermsEnum.accept(BytesRef term)
           
protected  FilteredTermsEnum.AcceptStatus TermRangeTermsEnum.accept(BytesRef term)
           
protected static int FieldComparator.binarySearch(BytesRef br, FieldCache.DocTermsIndex a, BytesRef key)
           
protected static int FieldComparator.binarySearch(BytesRef br, FieldCache.DocTermsIndex a, BytesRef key, int low, int high)
           
 int FieldCache.DocTermsIndex.binarySearchLookup(BytesRef key, BytesRef spare)
           
 int FieldComparator.TermOrdValComparator.compareDocToValue(int doc, BytesRef value)
           
 int FieldComparator.TermOrdValDocValuesComparator.compareDocToValue(int doc, BytesRef value)
           
 int FieldComparator.TermValComparator.compareDocToValue(int doc, BytesRef value)
           
 int FieldComparator.TermValDocValuesComparator.compareDocToValue(int doc, BytesRef value)
           
 int FieldComparator.TermValComparator.compareValues(BytesRef val1, BytesRef val2)
           
 int FieldComparator.TermValDocValuesComparator.compareValues(BytesRef val1, BytesRef val2)
           
protected  TermsEnum FuzzyTermsEnum.getAutomatonEnum(int editDistance, BytesRef lastTerm)
          return an automata-based enum for matching up to editDistance from lastTerm, if possible
abstract  BytesRef FieldCache.DocTerms.getTerm(int docID, BytesRef ret)
          The BytesRef argument must not be null; the method returns the same BytesRef, or an empty (length=0) BytesRef if the doc did not have this field or was deleted.
 BytesRef FieldCache.DocTermsIndex.getTerm(int docID, BytesRef reuse)
          Convenience method, to lookup the Term for a doc.
static TermRangeFilter TermRangeFilter.Less(String fieldName, BytesRef upperTerm)
          Constructs a filter for field fieldName matching less than or equal to upperTerm.
abstract  BytesRef FieldCache.DocTermsIndex.lookup(int ord, BytesRef reuse)
          The BytesRef argument must not be null; the method returns the same BytesRef, or an empty (length=0) BytesRef if this ord is the null ord (0).
protected  void FuzzyTermsEnum.maxEditDistanceChanged(BytesRef lastTerm, int maxEdits, boolean init)
           
static TermRangeFilter TermRangeFilter.More(String fieldName, BytesRef lowerTerm)
          Constructs a filter for field fieldName matching greater than or equal to lowerTerm.
 byte FieldCache.ByteParser.parseByte(BytesRef term)
          Return a single Byte representation of this field's value.
 double FieldCache.DoubleParser.parseDouble(BytesRef term)
          Return an long representation of this field's value.
 float FieldCache.FloatParser.parseFloat(BytesRef term)
          Return an float representation of this field's value.
 int FieldCache.IntParser.parseInt(BytesRef term)
          Return an integer representation of this field's value.
 long FieldCache.LongParser.parseLong(BytesRef term)
          Return an long representation of this field's value.
 short FieldCache.ShortParser.parseShort(BytesRef term)
          Return a short representation of this field's value.
 TermsEnum.SeekStatus FuzzyTermsEnum.seekCeil(BytesRef text, boolean useCache)
           
 boolean FuzzyTermsEnum.seekExact(BytesRef text, boolean useCache)
           
 void FuzzyTermsEnum.seekExact(BytesRef term, TermState state)
           
 void MaxNonCompetitiveBoostAttributeImpl.setCompetitiveTerm(BytesRef competitiveTerm)
           
 void MaxNonCompetitiveBoostAttribute.setCompetitiveTerm(BytesRef competitiveTerm)
          This is the term or null of the term that triggered the boost change.
 

Method parameters in org.apache.lucene.search with type arguments of type BytesRef
 void SortField.setBytesComparator(Comparator<BytesRef> b)
           
 

Constructors in org.apache.lucene.search with parameters of type BytesRef
FieldCacheTermsFilter(String field, BytesRef... terms)
           
PrefixTermsEnum(TermsEnum tenum, BytesRef prefixText)
           
TermRangeFilter(String fieldName, BytesRef lowerTerm, BytesRef upperTerm, boolean includeLower, boolean includeUpper)
           
TermRangeQuery(String field, BytesRef lowerTerm, BytesRef upperTerm, boolean includeLower, boolean includeUpper)
          Constructs a query selecting all terms greater/equal than lowerTerm but less/equal than upperTerm.
TermRangeTermsEnum(TermsEnum tenum, BytesRef lowerTerm, BytesRef upperTerm, boolean includeLower, boolean includeUpper)
          Enumerates all terms greater/equal than lowerTerm but less/equal than upperTerm.
TermStatistics(BytesRef term, long docFreq, long totalTermFreq)
           
 

Uses of BytesRef in org.apache.lucene.search.payloads
 

Fields in org.apache.lucene.search.payloads declared as BytesRef
protected  BytesRef PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer.payload
           
 

Uses of BytesRef in org.apache.lucene.search.similarities
 

Methods in org.apache.lucene.search.similarities with parameters of type BytesRef
abstract  float Similarity.SloppySimScorer.computePayloadFactor(int doc, int start, int end, BytesRef payload)
          Calculate a scoring factor based on the data in the payload.
protected  float BM25Similarity.scorePayload(int doc, int start, int end, BytesRef payload)
          The default implementation returns 1
abstract  float TFIDFSimilarity.scorePayload(int doc, int start, int end, BytesRef payload)
          Calculate a scoring factor based on the data in the payload.
 float DefaultSimilarity.scorePayload(int doc, int start, int end, BytesRef payload)
          The default implementation returns 1
 

Uses of BytesRef in org.apache.lucene.util
 

Fields in org.apache.lucene.util declared as BytesRef
static BytesRef UnicodeUtil.BIG_TERM
          A binary term consisting of a number of 0xff bytes, likely to be bigger than other terms one would normally encounter, and definitely bigger than any UTF-8 terms.
 

Methods in org.apache.lucene.util that return BytesRef
 BytesRef BytesRef.clone()
           
 BytesRef ByteBlockPool.copyFrom(BytesRef bytes)
           
static BytesRef BytesRef.deepCopyOf(BytesRef other)
          Creates a new BytesRef that points to a copy of the bytes from other
 BytesRef ByteBlockPool.deref(BytesRef bytes)
          Dereferences the byte block according to BytesRef offset.
 BytesRef PagedBytes.Reader.fill(BytesRef b, long start)
          Reads length as 1 or 2 byte vInt prefix, starting at start.
 BytesRef PagedBytes.Reader.fillSlice(BytesRef b, long start, int length)
          Gets a slice out of PagedBytes starting at start with a given length.
 BytesRef PagedBytes.Reader.fillSliceWithPrefix(BytesRef b, long start)
          Gets a slice out of PagedBytes starting at start, the length is read as 1 or 2 byte vInt prefix.
 BytesRef BytesRefHash.get(int ord, BytesRef ref)
          Populates and returns a BytesRef with the bytes for the given ord.
 BytesRef BytesRefIterator.next()
          Increments the iteration to the next BytesRef in the iterator.
 BytesRef ByteBlockPool.setBytesRef(BytesRef term, int textStart)
           
 

Methods in org.apache.lucene.util that return types with arguments of type BytesRef
 Comparator<BytesRef> BytesRefIterator.getComparator()
          Return the BytesRef Comparator used to sort terms provided by the iterator.
static Comparator<BytesRef> BytesRef.getUTF8SortedAsUnicodeComparator()
           
static Comparator<BytesRef> BytesRef.getUTF8SortedAsUTF16Comparator()
          Deprecated. This comparator is only a transition mechanism
 

Methods in org.apache.lucene.util with parameters of type BytesRef
 int BytesRefHash.add(BytesRef bytes)
          Adds a new BytesRef
 int BytesRefHash.add(BytesRef bytes, int code)
          Adds a new BytesRef with a pre-calculated hash code.
 void NumericUtils.LongRangeBuilder.addRange(BytesRef minPrefixCoded, BytesRef maxPrefixCoded)
          Overwrite this method, if you like to receive the already prefix encoded range bounds.
 void NumericUtils.IntRangeBuilder.addRange(BytesRef minPrefixCoded, BytesRef maxPrefixCoded)
          Overwrite this method, if you like to receive the already prefix encoded range bounds.
 void FuzzySet.addValue(BytesRef value)
          Records a value in the set.
 void BytesRef.append(BytesRef other)
          Appends the bytes from the given BytesRef
static int StringHelper.bytesDifference(BytesRef left, BytesRef right)
          Compares two BytesRef, element by element, and returns the number of elements common to both arrays.
 boolean BytesRef.bytesEquals(BytesRef other)
          Expert: compares the bytes against another BytesRef, returning true if the bytes are equal.
static int UnicodeUtil.codePointCount(BytesRef utf8)
          Returns the number of code points in this utf8 sequence.
 int BytesRef.compareTo(BytesRef other)
          Unsigned byte order comparison
 FuzzySet.ContainsResult FuzzySet.contains(BytesRef value)
          The main method required for a Bloom filter which, given a value determines set membership.
 void PagedBytes.copy(BytesRef bytes)
          Copy BytesRef in
 void ByteBlockPool.copy(BytesRef bytes)
          Copies the given BytesRef at the current positions ( ByteBlockPool.byteUpto across buffer boundaries
 void PagedBytes.copy(BytesRef bytes, BytesRef out)
          Copy BytesRef in, setting BytesRef out to the result.
 void BytesRef.copyBytes(BytesRef other)
          Copies the bytes from the given BytesRef
 BytesRef ByteBlockPool.copyFrom(BytesRef bytes)
           
 long PagedBytes.copyUsingLengthPrefix(BytesRef bytes)
          Copy bytes in, writing the length as a 1 or 2 byte vInt prefix.
static BytesRef BytesRef.deepCopyOf(BytesRef other)
          Creates a new BytesRef that points to a copy of the bytes from other
 BytesRef ByteBlockPool.deref(BytesRef bytes)
          Dereferences the byte block according to BytesRef offset.
static boolean StringHelper.endsWith(BytesRef ref, BytesRef suffix)
          Returns true iff the ref ends with the given suffix.
 BytesRef PagedBytes.Reader.fill(BytesRef b, long start)
          Reads length as 1 or 2 byte vInt prefix, starting at start.
 int PagedBytes.Reader.fillAndGetIndex(BytesRef b, long start)
          Reads length as 1 or 2 byte vInt prefix, starting at start.
 long PagedBytes.Reader.fillAndGetStart(BytesRef b, long start)
          Reads length as 1 or 2 byte vInt prefix, starting at start and returns the start offset of the next part, suitable as start parameter on next call to sequentially read all BytesRef.
 BytesRef PagedBytes.Reader.fillSlice(BytesRef b, long start, int length)
          Gets a slice out of PagedBytes starting at start with a given length.
 BytesRef PagedBytes.Reader.fillSliceWithPrefix(BytesRef b, long start)
          Gets a slice out of PagedBytes starting at start, the length is read as 1 or 2 byte vInt prefix.
 BytesRef BytesRefHash.get(int ord, BytesRef ref)
          Populates and returns a BytesRef with the bytes for the given ord.
static int NumericUtils.getPrefixCodedIntShift(BytesRef val)
          Returns the shift value from a prefix encoded int.
static int NumericUtils.getPrefixCodedLongShift(BytesRef val)
          Returns the shift value from a prefix encoded long.
static int NumericUtils.intToPrefixCoded(int val, int shift, BytesRef bytes)
          Returns prefix coded bits after reducing the precision by shift bits.
static int NumericUtils.longToPrefixCoded(long val, int shift, BytesRef bytes)
          Returns prefix coded bits after reducing the precision by shift bits.
static int NumericUtils.prefixCodedToInt(BytesRef val)
          Returns an int from prefixCoded bytes.
static long NumericUtils.prefixCodedToLong(BytesRef val)
          Returns a long from prefixCoded bytes.
 BytesRef ByteBlockPool.setBytesRef(BytesRef term, int textStart)
           
static boolean StringHelper.startsWith(BytesRef ref, BytesRef prefix)
          Returns true iff the ref starts with the given prefix.
static void UnicodeUtil.UTF16toUTF8(char[] source, int offset, int length, BytesRef result)
          Encode characters from a char[] source, starting at offset for length chars.
static void UnicodeUtil.UTF16toUTF8(CharSequence s, int offset, int length, BytesRef result)
          Encode characters from this String, starting at offset for length characters.
static int UnicodeUtil.UTF16toUTF8WithHash(char[] source, int offset, int length, BytesRef result)
          Encode characters from a char[] source, starting at offset for length chars.
static void UnicodeUtil.UTF8toUTF16(BytesRef bytesRef, CharsRef chars)
          Utility method for UnicodeUtil.UTF8toUTF16(byte[], int, int, CharsRef)
static void UnicodeUtil.UTF8toUTF32(BytesRef utf8, IntsRef utf32)
           
 

Method parameters in org.apache.lucene.util with type arguments of type BytesRef
 int[] BytesRefHash.sort(Comparator<BytesRef> comp)
          Returns the values array sorted by the referenced byte values.
 

Uses of BytesRef in org.apache.lucene.util.automaton
 

Fields in org.apache.lucene.util.automaton declared as BytesRef
 BytesRef CompiledAutomaton.commonSuffixRef
          Shared common suffix accepted by the automaton.
 BytesRef CompiledAutomaton.term
          For CompiledAutomaton.AUTOMATON_TYPE.PREFIX, this is the prefix term; for CompiledAutomaton.AUTOMATON_TYPE.SINGLE this is the singleton term.
 

Methods in org.apache.lucene.util.automaton that return BytesRef
 BytesRef CompiledAutomaton.floor(BytesRef input, BytesRef output)
          Finds largest term accepted by this Automaton, that's <= the provided input term.
static BytesRef SpecialOperations.getCommonPrefixBytesRef(Automaton a)
           
static BytesRef SpecialOperations.getCommonSuffixBytesRef(Automaton a)
           
 

Methods in org.apache.lucene.util.automaton with parameters of type BytesRef
 BytesRef CompiledAutomaton.floor(BytesRef input, BytesRef output)
          Finds largest term accepted by this Automaton, that's <= the provided input term.
 

Method parameters in org.apache.lucene.util.automaton with type arguments of type BytesRef
static Automaton BasicAutomata.makeStringUnion(Collection<BytesRef> utf8Strings)
          Returns a new (deterministic and minimal) automaton that accepts the union of the given collection of BytesRefs representing UTF-8 encoded strings.
 

Uses of BytesRef in org.apache.lucene.util.fst
 

Fields in org.apache.lucene.util.fst declared as BytesRef
 BytesRef BytesRefFSTEnum.InputOutput.input
           
 

Methods in org.apache.lucene.util.fst that return BytesRef
 BytesRef ByteSequenceOutputs.add(BytesRef prefix, BytesRef output)
           
 BytesRef ByteSequenceOutputs.common(BytesRef output1, BytesRef output2)
           
 BytesRef ByteSequenceOutputs.getNoOutput()
           
 BytesRef ByteSequenceOutputs.read(DataInput in)
           
 BytesRef ByteSequenceOutputs.subtract(BytesRef output, BytesRef inc)
           
static BytesRef Util.toBytesRef(IntsRef input, BytesRef scratch)
          Just converts IntsRef to BytesRef; you must ensure the int values fit into a byte.
 

Methods in org.apache.lucene.util.fst with parameters of type BytesRef
 BytesRef ByteSequenceOutputs.add(BytesRef prefix, BytesRef output)
           
 BytesRef ByteSequenceOutputs.common(BytesRef output1, BytesRef output2)
           
static
<T> T
Util.get(FST<T> fst, BytesRef input)
          Looks up the output for this input, or null if the input is not accepted
 String ByteSequenceOutputs.outputToString(BytesRef output)
           
 BytesRefFSTEnum.InputOutput<T> BytesRefFSTEnum.seekCeil(BytesRef target)
          Seeks to smallest term that's >= target.
 BytesRefFSTEnum.InputOutput<T> BytesRefFSTEnum.seekExact(BytesRef target)
          Seeks to exactly this term, returning null if the term doesn't exist.
 BytesRefFSTEnum.InputOutput<T> BytesRefFSTEnum.seekFloor(BytesRef target)
          Seeks to biggest term that's <= target.
 BytesRef ByteSequenceOutputs.subtract(BytesRef output, BytesRef inc)
           
static BytesRef Util.toBytesRef(IntsRef input, BytesRef scratch)
          Just converts IntsRef to BytesRef; you must ensure the int values fit into a byte.
static IntsRef Util.toIntsRef(BytesRef input, IntsRef scratch)
          Just takes unsigned byte values from the BytesRef and converts into an IntsRef.
 void ByteSequenceOutputs.write(BytesRef prefix, DataOutput out)
           
 

Uses of BytesRef in org.apache.lucene.util.hash
 

Methods in org.apache.lucene.util.hash with parameters of type BytesRef
 int MurmurHash2.hash(BytesRef br)
           
abstract  int HashFunction.hash(BytesRef bytes)
          Hashes the contents of the referenced bytes
 

Uses of BytesRef in org.apache.lucene.util.mutable
 

Fields in org.apache.lucene.util.mutable declared as BytesRef
 BytesRef MutableValueStr.value
           
 



Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.