com.laserfiche.repository.api.clients.impl.model

Class SearchContextHit

java.lang.Object

com.laserfiche.repository.api.clients.impl.model.SearchContextHit

@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen")
public class SearchContextHit
extends Object

Represents a context hit for a search result.

Constructor Summary

Constructors

Constructor and Description
SearchContextHit()

Method Summary

Modifier and Type	Method and Description
SearchContextHit	annotationId(Integer annotationId)
SearchContextHit	context(String context)
SearchContextHit	edocHitCount(Integer edocHitCount)
boolean	equals(Object o)
SearchContextHit	fieldHitCount(Integer fieldHitCount)
SearchContextHit	fieldName(String fieldName)
Integer	getAnnotationId() Returns the ID of the annotation that the context hit is in.
String	getContext() Returns the line of context for the search hit.
Integer	getEdocHitCount() Returns the number of hits in the electronic document.
Integer	getFieldHitCount() Returns the number of hits in the template.
String	getFieldName() Returns the name of a template field containing the hit.
Integer	getHighlight1Length() Returns the length of the first highlight in characters.
Integer	getHighlight1Offset() Returns the character offset from the beginning of the context line of the start of the first highlight.
Integer	getHighlight2Length() Returns the length of the second highlight in characters.
Integer	getHighlight2Offset() Returns the character offset from the beginning of the context line of the start of the second highlight.
Integer	getHitNumber() Returns the hit number.
HitType	getHitType() Returns hitType
Integer	getHitWidth() Returns the number of words in the context hit.
Integer	getPageNumber() Returns the page number in the document of the search hit's context.
Integer	getPageOffset() Returns the offset from the beginning of the page of the starting character of the search hit's context line.
int	hashCode()
SearchContextHit	highlight1Length(Integer highlight1Length)
SearchContextHit	highlight1Offset(Integer highlight1Offset)
SearchContextHit	highlight2Length(Integer highlight2Length)
SearchContextHit	highlight2Offset(Integer highlight2Offset)
SearchContextHit	hitNumber(Integer hitNumber)
SearchContextHit	hitType(HitType hitType)
SearchContextHit	hitWidth(Integer hitWidth)
Boolean	isAnnotationHit() Returns a boolean indicating if this context hit occurs on an annotation.
SearchContextHit	isAnnotationHit(Boolean isAnnotationHit)
SearchContextHit	pageNumber(Integer pageNumber)
SearchContextHit	pageOffset(Integer pageOffset)
void	setAnnotationId(Integer annotationId)
void	setContext(String context)
void	setEdocHitCount(Integer edocHitCount)
void	setFieldHitCount(Integer fieldHitCount)
void	setFieldName(String fieldName)
void	setHighlight1Length(Integer highlight1Length)
void	setHighlight1Offset(Integer highlight1Offset)
void	setHighlight2Length(Integer highlight2Length)
void	setHighlight2Offset(Integer highlight2Offset)
void	setHitNumber(Integer hitNumber)
void	setHitType(HitType hitType)
void	setHitWidth(Integer hitWidth)
void	setIsAnnotationHit(Boolean isAnnotationHit)
void	setPageNumber(Integer pageNumber)
void	setPageOffset(Integer pageOffset)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchContextHit

public SearchContextHit()

Method Detail

hitType

public SearchContextHit hitType(HitType hitType)

getHitType

public HitType getHitType()

Returns hitType

Returns:

hitType

setHitType

public void setHitType(HitType hitType)

isAnnotationHit

public SearchContextHit isAnnotationHit(Boolean isAnnotationHit)

isAnnotationHit

public Boolean isAnnotationHit()

Returns a boolean indicating if this context hit occurs on an annotation.

Returns:

isAnnotationHit

setIsAnnotationHit

public void setIsAnnotationHit(Boolean isAnnotationHit)

annotationId

public SearchContextHit annotationId(Integer annotationId)

getAnnotationId

public Integer getAnnotationId()

Returns the ID of the annotation that the context hit is in.

Returns:

annotationId

setAnnotationId

public void setAnnotationId(Integer annotationId)

pageNumber

public SearchContextHit pageNumber(Integer pageNumber)

getPageNumber

public Integer getPageNumber()

Returns the page number in the document of the search hit's context.

Returns:

pageNumber

setPageNumber

public void setPageNumber(Integer pageNumber)

pageOffset

public SearchContextHit pageOffset(Integer pageOffset)

getPageOffset

public Integer getPageOffset()

Returns the offset from the beginning of the page of the starting character of the search hit's context line.

Returns:

pageOffset

setPageOffset

public void setPageOffset(Integer pageOffset)

context

public SearchContextHit context(String context)

getContext

public String getContext()

Returns the line of context for the search hit.

Returns:

context

setContext

public void setContext(String context)

highlight1Offset

public SearchContextHit highlight1Offset(Integer highlight1Offset)

getHighlight1Offset

public Integer getHighlight1Offset()

Returns the character offset from the beginning of the context line of the start of the first highlight.

Returns:

highlight1Offset

setHighlight1Offset

public void setHighlight1Offset(Integer highlight1Offset)

highlight1Length

public SearchContextHit highlight1Length(Integer highlight1Length)

getHighlight1Length

public Integer getHighlight1Length()

Returns the length of the first highlight in characters.

Returns:

highlight1Length

setHighlight1Length

public void setHighlight1Length(Integer highlight1Length)

highlight2Offset

public SearchContextHit highlight2Offset(Integer highlight2Offset)

getHighlight2Offset

public Integer getHighlight2Offset()

Returns the character offset from the beginning of the context line of the start of the second highlight.

Returns:

highlight2Offset

setHighlight2Offset

public void setHighlight2Offset(Integer highlight2Offset)

highlight2Length

public SearchContextHit highlight2Length(Integer highlight2Length)

getHighlight2Length

public Integer getHighlight2Length()

Returns the length of the second highlight in characters.

Returns:

highlight2Length

setHighlight2Length

public void setHighlight2Length(Integer highlight2Length)

hitWidth

public SearchContextHit hitWidth(Integer hitWidth)

getHitWidth

public Integer getHitWidth()

Returns the number of words in the context hit.

Returns:

hitWidth

setHitWidth

public void setHitWidth(Integer hitWidth)

edocHitCount

public SearchContextHit edocHitCount(Integer edocHitCount)

getEdocHitCount

public Integer getEdocHitCount()

Returns the number of hits in the electronic document.

Returns:

edocHitCount

setEdocHitCount

public void setEdocHitCount(Integer edocHitCount)

fieldHitCount

public SearchContextHit fieldHitCount(Integer fieldHitCount)

getFieldHitCount

public Integer getFieldHitCount()

Returns the number of hits in the template.

Returns:

fieldHitCount

setFieldHitCount

public void setFieldHitCount(Integer fieldHitCount)

fieldName

public SearchContextHit fieldName(String fieldName)

getFieldName

public String getFieldName()

Returns the name of a template field containing the hit.

Returns:

fieldName

setFieldName

public void setFieldName(String fieldName)

hitNumber

public SearchContextHit hitNumber(Integer hitNumber)

getHitNumber

public Integer getHitNumber()

Returns the hit number.

Returns:

hitNumber

setHitNumber

public void setHitNumber(Integer hitNumber)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object