org.jahia.services.search

Class JCRNodeHit

java.lang.Object

org.jahia.services.search.AbstractHit<JCRNodeWrapper>

org.jahia.services.search.JCRNodeHit

All Implemented Interfaces:

Hit<JCRNodeWrapper>

Direct Known Subclasses:

FileHit, PageHit

public class JCRNodeHit
extends AbstractHit<JCRNodeWrapper>

Search result item, represented by the JCR node. Used as a view object in JSP templates.

Author:

Sergiy Shyrkov

Field Summary

Fields inherited from class org.jahia.services.search.AbstractHit

context, resource

Constructor Summary

Constructors

Constructor and Description
JCRNodeHit(JCRNodeWrapper node, RenderContext context) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
void	addRow(javax.jcr.query.Row row)
String	getContentType() Returns the MIME type of the hit content, if applicable.
Date	getCreated() Returns the content creation date.
String	getCreatedBy() Returns the resource author (creator).
JCRNodeWrapper	getDisplayableNode()
String	getExcerpt() Returns the short description, abstract or excerpt of the hit's content.
String	getIconType()
Date	getLastModified() Returns the last modification date.
String	getLastModifiedBy() Returns the last contributor.
String	getLink() Returns the URL to the hit page.
String	getName() Returns the name of this file or folder.
String	getPath()
Map<String,JCRPropertyWrapper>	getProperties()
List<javax.jcr.query.Row>	getRows() Returns the row objects from the query/search linked to this hit.
String	getTitle() Returns the title text.
String	getType() Returns the hit type.
List<Hit>	getUsages() Returns the list of hits that use the current hit.
void	setExcerpt(String excerpt)
void	setUsageFilterSites(Set<String> usageFilterSites)

Methods inherited from class org.jahia.services.search.AbstractHit

equals, getContext, getLinkTemplateType, getQueryParameter, getRawHit, getScore, hashCode, setLinkTemplateType, setQueryParameter, setScore, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JCRNodeHit

public JCRNodeHit(JCRNodeWrapper node,
                  RenderContext context)

Initializes an instance of this class.

Parameters:

node - search result item to be wrapped

context -

Method Detail

getContentType

public String getContentType()

Description copied from interface: Hit

Returns the MIME type of the hit content, if applicable.

Returns:

the MIME type of the hit content, if applicable

getCreated

public Date getCreated()

Description copied from interface: Hit

Returns the content creation date.

Returns:

the content creation date

getCreatedBy

public String getCreatedBy()

Description copied from interface: Hit

Returns the resource author (creator).

Returns:

the resource author (creator)

getLastModified

public Date getLastModified()

Description copied from interface: Hit

Returns the last modification date.

Returns:

the last modification date

getLastModifiedBy

public String getLastModifiedBy()

Description copied from interface: Hit

Returns the last contributor.

Returns:

the last contributor

getLink

public String getLink()

Description copied from interface: Hit

Returns the URL to the hit page.

Returns:

the URL to the hit page

getPath

public String getPath()

getProperties

public Map<String,JCRPropertyWrapper> getProperties()

getTitle

public String getTitle()

Description copied from interface: Hit

Returns the title text.

Returns:

the title text

getName

public String getName()

Returns the name of this file or folder.

Returns:

the name of this file or folder

getType

public String getType()

Description copied from interface: Hit

Returns the hit type.

Returns:

the hit type

getIconType

public String getIconType()

getUsages

public List<Hit> getUsages()

Description copied from interface: Hit

Returns the list of hits that use the current hit. If the underlying implementation doesn't support usages computation, this method should return an empty list.

Returns:

the list of hits that use the current hit or an empty list if no hits use this hit (or the implementation doesn't support usages computation)

getDisplayableNode

public JCRNodeWrapper getDisplayableNode()

setUsageFilterSites

public void setUsageFilterSites(Set<String> usageFilterSites)

getExcerpt

public String getExcerpt()

Description copied from interface: Hit

Returns the short description, abstract or excerpt of the hit's content.

Returns:

the short description, abstract or excerpt of the hit's content

setExcerpt

public void setExcerpt(String excerpt)

addRow

public void addRow(javax.jcr.query.Row row)

getRows

public List<javax.jcr.query.Row> getRows()

Returns the row objects from the query/search linked to this hit. Multiple query results (row) can be linked to a hit, because some nodes cannot be displayed on its own as they have no template, so the hit's link URL points to a parent node having a template, which can aggregate several sub-nodes.

Returns:

list of Row objects