com.exalead.mercury.mami.search.v20

Class PreviewCommand

java.lang.Object

com.exalead.mercury.mami.search.v20.Command

com.exalead.mercury.mami.search.v20.BaseFetchCommand

com.exalead.mercury.mami.search.v20.PreviewCommand

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class PreviewCommand
extends BaseFetchCommand
implements com.exalead.util.Checkable, java.io.Serializable

Retrieves rich HTML preview of the documents.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.BaseFetchCommand

BaseFetchCommand.Transformer<T>, BaseFetchCommand.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	convertAddresses
static java.lang.String	DEFAULT_DEFAULT_HIGHLIGHT_FACET_IDS
static java.lang.String	DEFAULT_DEFAULT_HIGHLIGHT_PREFIX_HANDLERS
java.lang.String	defaultHighlightFacetIds
java.lang.String	defaultHighlightPrefixHandlers
java.lang.String	defaultLogic

Fields inherited from class com.exalead.mercury.mami.search.v20.Command

base, DEFAULT_BASE

Constructor Summary

Constructors

Constructor and Description
PreviewCommand()
PreviewCommand(PreviewCommand o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(BaseFetchCommand.Transformer<T> transformer, T[] t)
void	accept(BaseFetchCommand.Visitor visitor)
<T> T	accept(Command.Transformer<T> transformer, T[] t)
void	accept(Command.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this PreviewCommand.
static PreviewCommand	fromString(java.lang.String s) String representation of this PreviewCommand.
java.lang.String	getConvertAddresses() Semicolon separated list of convert instance names or urls to use.
java.lang.String	getDefaultHighlightFacetIds() Comma-separated list of facets.
java.lang.String	getDefaultHighlightPrefixHandlers() Comma-separated list of prefix handlers that target the preview for highlight. The default prefix handler is "text".
java.lang.String	getDefaultLogic()
PreviewCommand	makeCopy() Creates and returns a deep copy of this PreviewCommand.
static PreviewCommand	readFrom(java.io.InputStream is) Read this PreviewCommand from an XML fragment.
void	setConvertAddresses(java.lang.String convertAddresses) Semicolon separated list of convert instance names or urls to use.
void	setDefaultHighlightFacetIds(java.lang.String defaultHighlightFacetIds) Comma-separated list of facets.
void	setDefaultHighlightPrefixHandlers(java.lang.String defaultHighlightPrefixHandlers) Comma-separated list of prefix handlers that target the preview for highlight. The default prefix handler is "text".
void	setDefaultLogic(java.lang.String defaultLogic)
java.lang.String	toString() String representation of this PreviewCommand.
PreviewCommand	withBase(java.lang.String base)
PreviewCommand	withConvertAddresses(java.lang.String convertAddresses)
PreviewCommand	withDefaultHighlightFacetIds(java.lang.String defaultHighlightFacetIds)
PreviewCommand	withDefaultHighlightPrefixHandlers(java.lang.String defaultHighlightPrefixHandlers)
PreviewCommand	withDefaultLogic(java.lang.String defaultLogic)
void	writeTo(java.io.OutputStream os) Write this PreviewCommand as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.Command

getBase, setBase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

defaultLogic

public java.lang.String defaultLogic

defaultHighlightPrefixHandlers

public java.lang.String defaultHighlightPrefixHandlers

DEFAULT_DEFAULT_HIGHLIGHT_PREFIX_HANDLERS

public static final java.lang.String DEFAULT_DEFAULT_HIGHLIGHT_PREFIX_HANDLERS

See Also:

Constant Field Values

defaultHighlightFacetIds

public java.lang.String defaultHighlightFacetIds

DEFAULT_DEFAULT_HIGHLIGHT_FACET_IDS

public static final java.lang.String DEFAULT_DEFAULT_HIGHLIGHT_FACET_IDS

See Also:

Constant Field Values

convertAddresses

public java.lang.String convertAddresses

Constructor Detail

PreviewCommand

public PreviewCommand()

PreviewCommand

public PreviewCommand(PreviewCommand o)

Copy constructor

Method Detail

withBase

public PreviewCommand withBase(java.lang.String base)

Overrides:

withBase in class BaseFetchCommand

setDefaultLogic

public void setDefaultLogic(java.lang.String defaultLogic)

getDefaultLogic

public java.lang.String getDefaultLogic()

withDefaultLogic

public PreviewCommand withDefaultLogic(java.lang.String defaultLogic)

setDefaultHighlightPrefixHandlers

public void setDefaultHighlightPrefixHandlers(java.lang.String defaultHighlightPrefixHandlers)

Comma-separated list of prefix handlers that target the preview for highlight.
The default prefix handler is "text".

getDefaultHighlightPrefixHandlers

public java.lang.String getDefaultHighlightPrefixHandlers()

Comma-separated list of prefix handlers that target the preview for highlight.
The default prefix handler is "text".

withDefaultHighlightPrefixHandlers

public PreviewCommand withDefaultHighlightPrefixHandlers(java.lang.String defaultHighlightPrefixHandlers)

setDefaultHighlightFacetIds

public void setDefaultHighlightFacetIds(java.lang.String defaultHighlightFacetIds)

Comma-separated list of facets. Refinements on categories are highlighted
in the preview if they have a parent category in this attribute.

getDefaultHighlightFacetIds

public java.lang.String getDefaultHighlightFacetIds()

Comma-separated list of facets. Refinements on categories are highlighted
in the preview if they have a parent category in this attribute.

withDefaultHighlightFacetIds

public PreviewCommand withDefaultHighlightFacetIds(java.lang.String defaultHighlightFacetIds)

setConvertAddresses

public void setConvertAddresses(java.lang.String convertAddresses)

Semicolon separated list of convert instance names or urls to use.

getConvertAddresses

public java.lang.String getConvertAddresses()

Semicolon separated list of convert instance names or urls to use.

withConvertAddresses

public PreviewCommand withConvertAddresses(java.lang.String convertAddresses)

makeCopy

public PreviewCommand makeCopy()

Creates and returns a deep copy of this PreviewCommand.

Overrides:

makeCopy in class BaseFetchCommand

readFrom

public static PreviewCommand readFrom(java.io.InputStream is)
                               throws javax.xml.bind.JAXBException

Read this PreviewCommand from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this PreviewCommand as an XML fragment

Overrides:

writeTo in class BaseFetchCommand

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static PreviewCommand fromString(java.lang.String s)
                                 throws javax.xml.bind.JAXBException,
                                        java.io.UnsupportedEncodingException

String representation of this PreviewCommand.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PreviewCommand.

Overrides:

toString in class BaseFetchCommand

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this PreviewCommand.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BaseFetchCommand

Throws:

com.exalead.util.TypedException

accept

public void accept(BaseFetchCommand.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class BaseFetchCommand

Throws:

com.exalead.util.TypedException

accept

public void accept(Command.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class Command

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(BaseFetchCommand.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class BaseFetchCommand

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(Command.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class Command

Throws:

com.exalead.util.TypedException