com.day.cq.search.writer

Class SimpleHitWriter

java.lang.Object

com.day.cq.search.writer.SimpleHitWriter

All Implemented Interfaces:

ResultHitWriter

public class SimpleHitWriter
extends java.lang.Object
implements ResultHitWriter

SimpleHitWriter writes common properties that are available on most JCR nodes, eg. path, excerpt, name, title, lastModified, created, size and mimeType.

Field Summary

Fields

Modifier and Type	Field and Description
static long	GIGA_BYTE
static long	KILO_BYTE
static long	MEGA_BYTE
static long	PETA_BYTE
static long	TERA_BYTE

Constructor Summary

Constructors

Constructor and Description
SimpleHitWriter()

Method Summary

Modifier and Type	Method and Description
void	write(Hit hit, JSONWriter writer, Query query) Writes a given Hit into the JSONWriter.
static void	writeSimpleJson(Hit hit, JSONWriter writer)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KILO_BYTE

public static final long KILO_BYTE

See Also:

Constant Field Values

MEGA_BYTE

public static final long MEGA_BYTE

See Also:

Constant Field Values

GIGA_BYTE

public static final long GIGA_BYTE

See Also:

Constant Field Values

TERA_BYTE

public static final long TERA_BYTE

See Also:

Constant Field Values

PETA_BYTE

public static final long PETA_BYTE

See Also:

Constant Field Values

Constructor Detail

SimpleHitWriter

public SimpleHitWriter()

Method Detail

write

public void write(Hit hit,
                  JSONWriter writer,
                  Query query)
           throws RepositoryException,
                  JSONException

Description copied from interface: ResultHitWriter

Writes a given Hit into the JSONWriter. This will be called for each hit of the result page. The surrounding json structure is an array and each entry should be a simple object. The caller will have invoked the writer.object() already and will call writer.endObject() directly after this method returns.

Specified by:

write in interface ResultHitWriter

Parameters:

hit - the result hit to render

writer - to output json

query - the original query; can be used to access custom parameters set in the predicate root group ( query.getPredicates().get("param", "default"))

Throws:

RepositoryException - in case access on the hit failed

JSONException - in case there is a problem with writing to the jsonwriter

writeSimpleJson

public static void writeSimpleJson(Hit hit,
                                   JSONWriter writer)
                            throws RepositoryException,
                                   JSONException

Throws:

RepositoryException

JSONException