Serialized Form (BlackLab 2.0.0 API)

Package nl.inl.blacklab.exceptions
- Class nl.inl.blacklab.exceptions.BlackLabException extends Exception implements Serializable
- Class nl.inl.blacklab.exceptions.BlackLabRuntimeException extends RuntimeException implements Serializable
- Class nl.inl.blacklab.exceptions.DocumentFormatNotFound extends BlackLabException implements Serializable
- Class nl.inl.blacklab.exceptions.ErrorOpeningIndex extends BlackLabException implements Serializable
- Class nl.inl.blacklab.exceptions.IndexTooOld extends ErrorOpeningIndex implements Serializable
- Class nl.inl.blacklab.exceptions.InsufficientMemoryAvailable extends BlackLabRuntimeException implements Serializable
- Class nl.inl.blacklab.exceptions.InterruptedSearch extends BlackLabRuntimeException implements Serializable
- Class nl.inl.blacklab.exceptions.InvalidConfiguration extends BlackLabRuntimeException implements Serializable
- Class nl.inl.blacklab.exceptions.InvalidInputFormatConfig extends BlackLabRuntimeException implements Serializable
- Class nl.inl.blacklab.exceptions.InvalidQuery extends BlackLabException implements Serializable
- Class nl.inl.blacklab.exceptions.LogException extends BlackLabRuntimeException implements Serializable
- Class nl.inl.blacklab.exceptions.MalformedInputFile extends BlackLabRuntimeException implements Serializable
- Class nl.inl.blacklab.exceptions.MaxDocsReached extends BlackLabRuntimeException implements Serializable
- Class nl.inl.blacklab.exceptions.PluginException extends BlackLabException implements Serializable
- Class nl.inl.blacklab.exceptions.RegexpTooLarge extends InvalidQuery implements Serializable
- Class nl.inl.blacklab.exceptions.ResultNotFound extends BlackLabException implements Serializable
- Class nl.inl.blacklab.exceptions.WildcardTermTooBroad extends InvalidQuery implements Serializable
Package nl.inl.blacklab.queryParser.contextql
- Class nl.inl.blacklab.queryParser.contextql.ParseException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - currentToken
```
Token currentToken
```
      This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token.
    - expectedTokenSequences
```
int[][] expectedTokenSequences
```
      Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.
    - tokenImage
```
String[] tokenImage
```
      This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.
- Class nl.inl.blacklab.queryParser.contextql.Token extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - kind
```
int kind
```
      An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.
    - beginLine
```
int beginLine
```
      The line number of the first character of this Token.
    - beginColumn
```
int beginColumn
```
      The column number of the first character of this Token.
    - endLine
```
int endLine
```
      The line number of the last character of this Token.
    - endColumn
```
int endColumn
```
      The column number of the last character of this Token.
    - image
```
String image
```
      The string image of the token.
    - next
```
Token next
```
      A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.
    - specialToken
```
Token specialToken
```
      This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.
- Class nl.inl.blacklab.queryParser.contextql.TokenMgrError extends Error implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - errorCode
```
int errorCode
```
      Indicates the reason why the exception is thrown. It will have one of the above 4 values.
Package nl.inl.blacklab.queryParser.corpusql
- Class nl.inl.blacklab.queryParser.corpusql.MalformedTagException extends ParseException implements Serializable
- Class nl.inl.blacklab.queryParser.corpusql.ParseException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - currentToken
```
Token currentToken
```
      This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token.
    - expectedTokenSequences
```
int[][] expectedTokenSequences
```
      Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.
    - tokenImage
```
String[] tokenImage
```
      This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.
- Class nl.inl.blacklab.queryParser.corpusql.SingleQuotesException extends ParseException implements Serializable
- Class nl.inl.blacklab.queryParser.corpusql.Token extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - kind
```
int kind
```
      An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.
    - beginLine
```
int beginLine
```
      The line number of the first character of this Token.
    - beginColumn
```
int beginColumn
```
      The column number of the first character of this Token.
    - endLine
```
int endLine
```
      The line number of the last character of this Token.
    - endColumn
```
int endColumn
```
      The column number of the last character of this Token.
    - image
```
String image
```
      The string image of the token.
    - next
```
Token next
```
      A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.
    - specialToken
```
Token specialToken
```
      This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.
- Class nl.inl.blacklab.queryParser.corpusql.TokenMgrError extends Error implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - errorCode
```
int errorCode
```
      Indicates the reason why the exception is thrown. It will have one of the above 4 values.
Package nl.inl.blacklab.resultproperty
- Class nl.inl.blacklab.resultproperty.DocGroupProperty extends GroupProperty<DocResult,DocGroup> implements Serializable
- Class nl.inl.blacklab.resultproperty.DocGroupPropertyIdentity extends DocGroupProperty implements Serializable
- Class nl.inl.blacklab.resultproperty.DocGroupPropertySize extends DocGroupProperty implements Serializable
- Class nl.inl.blacklab.resultproperty.DocProperty extends Object implements Serializable
  - Serialized Fields
    - reverse
```
boolean reverse
```
      Reverse comparison result or not?
- Class nl.inl.blacklab.resultproperty.DocPropertyAnnotatedFieldLength extends DocProperty implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
    - friendlyName
```
String friendlyName
```
    - docValues
```
Map<K,V> docValues
```
      The DocValues per segment (keyed by docBase), or null if we don't have docValues
    - index
```
BlackLabIndex index
```
- Class nl.inl.blacklab.resultproperty.DocPropertyDecade extends DocProperty implements Serializable
  - Serialized Fields
    - index
```
BlackLabIndex index
```
    - fieldName
```
String fieldName
```
    - docPropStoredField
```
DocPropertyStoredField docPropStoredField
```
- Class nl.inl.blacklab.resultproperty.DocPropertyId extends DocProperty implements Serializable
- Class nl.inl.blacklab.resultproperty.DocPropertyMultiple extends DocProperty implements Serializable
  - Serialized Fields
    - criteria
```
List<E> criteria
```
- Class nl.inl.blacklab.resultproperty.DocPropertyNumberOfHits extends DocProperty implements Serializable
- Class nl.inl.blacklab.resultproperty.DocPropertyStoredField extends DocProperty implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
      Lucene field name
    - friendlyName
```
String friendlyName
```
      Display name for the field
    - docValues
```
Map<K,V> docValues
```
      The DocValues per segment (keyed by docBase), or null if we don't have docValues
    - index
```
BlackLabIndex index
```
      Our index
- Class nl.inl.blacklab.resultproperty.GroupProperty extends Object implements Serializable
  - Serialized Fields
    - reverse
```
boolean reverse
```
      Reverse comparison result or not?
- Class nl.inl.blacklab.resultproperty.HitGroupProperty extends GroupProperty<Hit,HitGroup> implements Serializable
- Class nl.inl.blacklab.resultproperty.HitGroupPropertyIdentity extends HitGroupProperty implements Serializable
- Class nl.inl.blacklab.resultproperty.HitGroupPropertySize extends HitGroupProperty implements Serializable
- Class nl.inl.blacklab.resultproperty.HitProperty extends Object implements Serializable
  - Serialized Fields
    - hits
```
Results<T> hits
```
      The Hits object we're looking at
    - reverse
```
boolean reverse
```
      Reverse comparison result or not?
    - contexts
```
Contexts contexts
```
      Hit contexts, if any
    - contextIndices
```
List<E> contextIndices
```
      For HitProperties that need context, the context indices that correspond to the context(s) they need in the result set. (in the same order as reported by needsContext()).
- Class nl.inl.blacklab.resultproperty.HitPropertyContextBase extends HitProperty implements Serializable
  - Serialized Fields
    - terms
```
Terms terms
```
    - annotation
```
Annotation annotation
```
    - sensitivity
```
MatchSensitivity sensitivity
```
    - contextSize
```
ContextSize contextSize
```
    - name
```
String name
```
    - serializeName
```
String serializeName
```
    - index
```
BlackLabIndex index
```
- Class nl.inl.blacklab.resultproperty.HitPropertyContextWords extends HitProperty implements Serializable
  - Serialized Fields
    - annotation
```
Annotation annotation
```
    - sensitivity
```
MatchSensitivity sensitivity
```
    - index
```
BlackLabIndex index
```
    - words
```
List<E> words
```
    - totalWords
```
int totalWords
```
- Class nl.inl.blacklab.resultproperty.HitPropertyDoc extends HitProperty implements Serializable
  - Serialized Fields
    - index
```
BlackLabIndex index
```
- Class nl.inl.blacklab.resultproperty.HitPropertyDocumentDecade extends HitProperty implements Serializable
  - Serialized Fields
    - index
```
BlackLabIndex index
```
    - reader
```
org.apache.lucene.index.IndexReader reader
```
    - fieldName
```
String fieldName
```
    - docPropertyDocumentDecade
```
DocPropertyDecade docPropertyDocumentDecade
```
- Class nl.inl.blacklab.resultproperty.HitPropertyDocumentId extends HitProperty implements Serializable
- Class nl.inl.blacklab.resultproperty.HitPropertyDocumentStoredField extends HitProperty implements Serializable
  - Serialized Fields
    - index
```
BlackLabIndex index
```
    - reader
```
org.apache.lucene.index.IndexReader reader
```
    - fieldName
```
String fieldName
```
    - docPropStoredField
```
DocPropertyStoredField docPropStoredField
```
- Class nl.inl.blacklab.resultproperty.HitPropertyHitPosition extends HitProperty implements Serializable
- Class nl.inl.blacklab.resultproperty.HitPropertyHitText extends HitPropertyContextBase implements Serializable
- Class nl.inl.blacklab.resultproperty.HitPropertyLeftContext extends HitPropertyContextBase implements Serializable
- Class nl.inl.blacklab.resultproperty.HitPropertyMultiple extends HitProperty implements Serializable
  - Serialized Fields
    - properties
```
List<E> properties
```
      The properties we're combining
    - contextNeeded
```
List<E> contextNeeded
```
      All the contexts needed by the criteria
    - contextIndicesPerProperty
```
Map<K,V> contextIndicesPerProperty
```
      Which of the contexts do the individual properties need?
- Class nl.inl.blacklab.resultproperty.HitPropertyRightContext extends HitPropertyContextBase implements Serializable
- Class nl.inl.blacklab.resultproperty.HitPropertyWordLeft extends HitPropertyContextBase implements Serializable
- Class nl.inl.blacklab.resultproperty.HitPropertyWordRight extends HitPropertyContextBase implements Serializable

Serialized Form

Package nl.inl.blacklab.exceptions

Class nl.inl.blacklab.exceptions.BlackLabException extends Exception implements Serializable

Class nl.inl.blacklab.exceptions.BlackLabRuntimeException extends RuntimeException implements Serializable

Class nl.inl.blacklab.exceptions.DocumentFormatNotFound extends BlackLabException implements Serializable

Class nl.inl.blacklab.exceptions.ErrorOpeningIndex extends BlackLabException implements Serializable

Class nl.inl.blacklab.exceptions.IndexTooOld extends ErrorOpeningIndex implements Serializable

Class nl.inl.blacklab.exceptions.InsufficientMemoryAvailable extends BlackLabRuntimeException implements Serializable

Class nl.inl.blacklab.exceptions.InterruptedSearch extends BlackLabRuntimeException implements Serializable

Class nl.inl.blacklab.exceptions.InvalidConfiguration extends BlackLabRuntimeException implements Serializable

Class nl.inl.blacklab.exceptions.InvalidInputFormatConfig extends BlackLabRuntimeException implements Serializable

Class nl.inl.blacklab.exceptions.InvalidQuery extends BlackLabException implements Serializable

Class nl.inl.blacklab.exceptions.LogException extends BlackLabRuntimeException implements Serializable

Class nl.inl.blacklab.exceptions.MalformedInputFile extends BlackLabRuntimeException implements Serializable

Class nl.inl.blacklab.exceptions.MaxDocsReached extends BlackLabRuntimeException implements Serializable

Class nl.inl.blacklab.exceptions.PluginException extends BlackLabException implements Serializable

Class nl.inl.blacklab.exceptions.RegexpTooLarge extends InvalidQuery implements Serializable

Class nl.inl.blacklab.exceptions.ResultNotFound extends BlackLabException implements Serializable

Class nl.inl.blacklab.exceptions.WildcardTermTooBroad extends InvalidQuery implements Serializable

Package nl.inl.blacklab.queryParser.contextql

Class nl.inl.blacklab.queryParser.contextql.ParseException extends Exception implements Serializable

Serialized Fields

currentToken

expectedTokenSequences

tokenImage

Class nl.inl.blacklab.queryParser.contextql.Token extends Object implements Serializable

Serialized Fields

kind

beginLine

beginColumn

endLine

endColumn

image

next

specialToken

Class nl.inl.blacklab.queryParser.contextql.TokenMgrError extends Error implements Serializable

Serialized Fields

errorCode

Package nl.inl.blacklab.queryParser.corpusql

Class nl.inl.blacklab.queryParser.corpusql.MalformedTagException extends ParseException implements Serializable

Class nl.inl.blacklab.queryParser.corpusql.ParseException extends Exception implements Serializable

Serialized Fields

currentToken

expectedTokenSequences

tokenImage

Class nl.inl.blacklab.queryParser.corpusql.SingleQuotesException extends ParseException implements Serializable

Class nl.inl.blacklab.queryParser.corpusql.Token extends Object implements Serializable

Serialized Fields

kind

beginLine

beginColumn

endLine

endColumn

image

next

specialToken

Class nl.inl.blacklab.queryParser.corpusql.TokenMgrError extends Error implements Serializable

Serialized Fields

errorCode

Package nl.inl.blacklab.resultproperty

Class nl.inl.blacklab.resultproperty.DocGroupProperty extends GroupProperty<DocResult,DocGroup> implements Serializable

Class nl.inl.blacklab.resultproperty.DocGroupPropertyIdentity extends DocGroupProperty implements Serializable

Class nl.inl.blacklab.resultproperty.DocGroupPropertySize extends DocGroupProperty implements Serializable

Class nl.inl.blacklab.resultproperty.DocProperty extends Object implements Serializable

Serialized Fields

reverse

Class nl.inl.blacklab.resultproperty.DocPropertyAnnotatedFieldLength extends DocProperty implements Serializable

Serialized Fields

fieldName

friendlyName

docValues

index

Class nl.inl.blacklab.resultproperty.DocPropertyDecade extends DocProperty implements Serializable

Serialized Fields

index

fieldName

docPropStoredField

Class nl.inl.blacklab.resultproperty.DocPropertyId extends DocProperty implements Serializable

Class nl.inl.blacklab.resultproperty.DocPropertyMultiple extends DocProperty implements Serializable

Serialized Fields