com.exalead.search.v30

Class AttrGraphConfig

java.lang.Object

com.exalead.search.v30.AttrGraphConfig

All Implemented Interfaces:

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

public class AttrGraphConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_INTERMEDIATE_NODES_IN_ANSWER
static long	DEFAULT_MAX_PATHS
boolean	intermediateNodesInAnswer
long	maxPaths

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AttrGraphConfig.
static AttrGraphConfig	fromString(java.lang.String s) String representation of this AttrGraphConfig.
long	getMaxPaths() Limit the number of paths returned by an expand.
boolean	isIntermediateNodesInAnswer() If set to True, intermediate nodes will be returned.
AttrGraphConfig	makeCopy() Creates and returns a deep copy of this AttrGraphConfig.
static AttrGraphConfig	readFrom(java.io.InputStream is) Read this AttrGraphConfig from an XML fragment.
void	setIntermediateNodesInAnswer(boolean intermediateNodesInAnswer) If set to True, intermediate nodes will be returned.
void	setMaxPaths(long maxPaths) Limit the number of paths returned by an expand.
java.lang.String	toString() String representation of this AttrGraphConfig.
AttrGraphConfig	withIntermediateNodesInAnswer(boolean intermediateNodesInAnswer)
AttrGraphConfig	withIntermediateNodesInAnswer(java.lang.Boolean intermediateNodesInAnswer)
AttrGraphConfig	withMaxPaths(long maxPaths)
AttrGraphConfig	withMaxPaths(java.lang.Long maxPaths)
void	writeTo(java.io.OutputStream os) Write this AttrGraphConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

maxPaths

public long maxPaths

DEFAULT_MAX_PATHS

public static final long DEFAULT_MAX_PATHS

See Also:

Constant Field Values

intermediateNodesInAnswer

public boolean intermediateNodesInAnswer

DEFAULT_INTERMEDIATE_NODES_IN_ANSWER

public static final boolean DEFAULT_INTERMEDIATE_NODES_IN_ANSWER

See Also:

Constant Field Values

Constructor Detail

AttrGraphConfig

public AttrGraphConfig()

AttrGraphConfig

public AttrGraphConfig(AttrGraphConfig o)

Copy constructor

Method Detail

setMaxPaths

public void setMaxPaths(long maxPaths)

Limit the number of paths returned by an expand. The whole expand is still done, but the number of paths written in the message is limited.
The value of numPaths is not affected.

getMaxPaths

public long getMaxPaths()

Limit the number of paths returned by an expand. The whole expand is still done, but the number of paths written in the message is limited.
The value of numPaths is not affected.

withMaxPaths

public AttrGraphConfig withMaxPaths(long maxPaths)

withMaxPaths

public AttrGraphConfig withMaxPaths(java.lang.Long maxPaths)

setIntermediateNodesInAnswer

public void setIntermediateNodesInAnswer(boolean intermediateNodesInAnswer)

If set to True, intermediate nodes will be returned.

isIntermediateNodesInAnswer

public boolean isIntermediateNodesInAnswer()

If set to True, intermediate nodes will be returned.

withIntermediateNodesInAnswer

public AttrGraphConfig withIntermediateNodesInAnswer(boolean intermediateNodesInAnswer)

withIntermediateNodesInAnswer

public AttrGraphConfig withIntermediateNodesInAnswer(java.lang.Boolean intermediateNodesInAnswer)

makeCopy

public AttrGraphConfig makeCopy()

Creates and returns a deep copy of this AttrGraphConfig.

readFrom

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

Read this AttrGraphConfig 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 AttrGraphConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AttrGraphConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AttrGraphConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this AttrGraphConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException