ExpansionParams (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.datamodel.v10.ExpansionParams

All Implemented Interfaces:

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

Direct Known Subclasses:

AdvancedParams
```
public class ExpansionParams
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_GENERATE_ANALYSIS`
`static boolean`	`DEFAULT_GENERATE_FACET`
`static boolean`	`DEFAULT_GENERATE_INDEX_SCHEMA`
`static boolean`	`DEFAULT_GENERATE_META`
`static boolean`	`DEFAULT_GENERATE_PREFIX`
`java.lang.String`	`expandedPipelines`
`java.lang.String`	`expandedSearchLogics`
`boolean`	`generateAnalysis`
`boolean`	`generateFacet`
`boolean`	`generateIndexSchema`
`boolean`	`generateMeta`
`boolean`	`generatePrefix`

Constructor Summary

Constructors
Constructor and Description

ExpansionParams()

ExpansionParams(ExpansionParams o)
Copy constructor

Constructors
Constructor and Description
`ExpansionParams()`
`ExpansionParams(ExpansionParams o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this ExpansionParams.
`static ExpansionParams`	`fromString(java.lang.String s)` String representation of this ExpansionParams.
`java.lang.String`	`getExpandedPipelines()` A comma-separated list of analysis pipelines to generate mappings and document processors on.
`java.lang.String`	`getExpandedSearchLogics()` A comma-separated list of search logics to generate prefix handlers, facets and hit metas on.
`boolean`	`isGenerateAnalysis()` Creates the required mappings and document processors for this property.
`boolean`	`isGenerateFacet()` Creates a category facet in the search logics for this property.
`boolean`	`isGenerateIndexSchema()` Creates the required index fields for this property.
`boolean`	`isGenerateMeta()` Creates a hit meta in the search logics for this property.
`boolean`	`isGeneratePrefix()` Creates a prefix handler in the search logics for this property.
`ExpansionParams`	`makeCopy()` Creates and returns a deep copy of this ExpansionParams.
`static ExpansionParams`	`readFrom(java.io.InputStream is)` Read this ExpansionParams from an XML fragment.
`void`	`setExpandedPipelines(java.lang.String expandedPipelines)` A comma-separated list of analysis pipelines to generate mappings and document processors on.
`void`	`setExpandedSearchLogics(java.lang.String expandedSearchLogics)` A comma-separated list of search logics to generate prefix handlers, facets and hit metas on.
`void`	`setGenerateAnalysis(boolean generateAnalysis)` Creates the required mappings and document processors for this property.
`void`	`setGenerateFacet(boolean generateFacet)` Creates a category facet in the search logics for this property.
`void`	`setGenerateIndexSchema(boolean generateIndexSchema)` Creates the required index fields for this property.
`void`	`setGenerateMeta(boolean generateMeta)` Creates a hit meta in the search logics for this property.
`void`	`setGeneratePrefix(boolean generatePrefix)` Creates a prefix handler in the search logics for this property.
`java.lang.String`	`toString()` String representation of this ExpansionParams.
`ExpansionParams`	`withExpandedPipelines(java.lang.String expandedPipelines)`
`ExpansionParams`	`withExpandedSearchLogics(java.lang.String expandedSearchLogics)`
`ExpansionParams`	`withGenerateAnalysis(boolean generateAnalysis)`
`ExpansionParams`	`withGenerateAnalysis(java.lang.Boolean generateAnalysis)`
`ExpansionParams`	`withGenerateFacet(boolean generateFacet)`
`ExpansionParams`	`withGenerateFacet(java.lang.Boolean generateFacet)`
`ExpansionParams`	`withGenerateIndexSchema(boolean generateIndexSchema)`
`ExpansionParams`	`withGenerateIndexSchema(java.lang.Boolean generateIndexSchema)`
`ExpansionParams`	`withGenerateMeta(boolean generateMeta)`
`ExpansionParams`	`withGenerateMeta(java.lang.Boolean generateMeta)`
`ExpansionParams`	`withGeneratePrefix(boolean generatePrefix)`
`ExpansionParams`	`withGeneratePrefix(java.lang.Boolean generatePrefix)`
`void`	`writeTo(java.io.OutputStream os)` Write this ExpansionParams as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - generateAnalysis
```
public boolean generateAnalysis
```
  - DEFAULT_GENERATE_ANALYSIS
```
public static final boolean DEFAULT_GENERATE_ANALYSIS
```
    See Also:
    
    Constant Field Values
  - generateIndexSchema
```
public boolean generateIndexSchema
```
  - DEFAULT_GENERATE_INDEX_SCHEMA
```
public static final boolean DEFAULT_GENERATE_INDEX_SCHEMA
```
    See Also:
    
    Constant Field Values
  - generatePrefix
```
public boolean generatePrefix
```
  - DEFAULT_GENERATE_PREFIX
```
public static final boolean DEFAULT_GENERATE_PREFIX
```
    See Also:
    
    Constant Field Values
  - generateFacet
```
public boolean generateFacet
```
  - DEFAULT_GENERATE_FACET
```
public static final boolean DEFAULT_GENERATE_FACET
```
    See Also:
    
    Constant Field Values
  - generateMeta
```
public boolean generateMeta
```
  - DEFAULT_GENERATE_META
```
public static final boolean DEFAULT_GENERATE_META
```
    See Also:
    
    Constant Field Values
  - expandedPipelines
```
public java.lang.String expandedPipelines
```
  - expandedSearchLogics
```
public java.lang.String expandedSearchLogics
```
- Constructor Detail
  - ExpansionParams
```
public ExpansionParams()
```
  - ExpansionParams
```
public ExpansionParams(ExpansionParams o)
```
    Copy constructor
- Method Detail
  - setGenerateAnalysis
```
public void setGenerateAnalysis(boolean generateAnalysis)
```
    Creates the required mappings and document processors for this property. Only set this option to "false" to take complete control over analysis expansion for this property.
  - isGenerateAnalysis
```
public boolean isGenerateAnalysis()
```
    Creates the required mappings and document processors for this property. Only set this option to "false" to take complete control over analysis expansion for this property.
  - withGenerateAnalysis
```
public ExpansionParams withGenerateAnalysis(boolean generateAnalysis)
```
  - withGenerateAnalysis
```
public ExpansionParams withGenerateAnalysis(java.lang.Boolean generateAnalysis)
```
  - setGenerateIndexSchema
```
public void setGenerateIndexSchema(boolean generateIndexSchema)
```
    Creates the required index fields for this property. Only set this option to "false" to take complete control over index schema expansion for this property.
  - isGenerateIndexSchema
```
public boolean isGenerateIndexSchema()
```
    Creates the required index fields for this property. Only set this option to "false" to take complete control over index schema expansion for this property.
  - withGenerateIndexSchema
```
public ExpansionParams withGenerateIndexSchema(boolean generateIndexSchema)
```
  - withGenerateIndexSchema
```
public ExpansionParams withGenerateIndexSchema(java.lang.Boolean generateIndexSchema)
```
  - setGeneratePrefix
```
public void setGeneratePrefix(boolean generatePrefix)
```
    Creates a prefix handler in the search logics for this property. Only set this option to "false" to take complete control over query prefix handler expansion for this property.
  - isGeneratePrefix
```
public boolean isGeneratePrefix()
```
    Creates a prefix handler in the search logics for this property. Only set this option to "false" to take complete control over query prefix handler expansion for this property.
  - withGeneratePrefix
```
public ExpansionParams withGeneratePrefix(boolean generatePrefix)
```
  - withGeneratePrefix
```
public ExpansionParams withGeneratePrefix(java.lang.Boolean generatePrefix)
```
  - setGenerateFacet
```
public void setGenerateFacet(boolean generateFacet)
```
    Creates a category facet in the search logics for this property. Only set this option to "false" to take complete control over facet config expansion for this property.
  - isGenerateFacet
```
public boolean isGenerateFacet()
```
    Creates a category facet in the search logics for this property. Only set this option to "false" to take complete control over facet config expansion for this property.
  - withGenerateFacet
```
public ExpansionParams withGenerateFacet(boolean generateFacet)
```
  - withGenerateFacet
```
public ExpansionParams withGenerateFacet(java.lang.Boolean generateFacet)
```
  - setGenerateMeta
```
public void setGenerateMeta(boolean generateMeta)
```
    Creates a hit meta in the search logics for this property. Only set this option to "false" to take complete control over meta expansion for this property.
  - isGenerateMeta
```
public boolean isGenerateMeta()
```
    Creates a hit meta in the search logics for this property. Only set this option to "false" to take complete control over meta expansion for this property.
  - withGenerateMeta
```
public ExpansionParams withGenerateMeta(boolean generateMeta)
```
  - withGenerateMeta
```
public ExpansionParams withGenerateMeta(java.lang.Boolean generateMeta)
```
  - setExpandedPipelines
```
public void setExpandedPipelines(java.lang.String expandedPipelines)
```
    A comma-separated list of analysis pipelines to generate mappings and document processors on. If empty, generate on all pipelines.
  - getExpandedPipelines
```
public java.lang.String getExpandedPipelines()
```
    A comma-separated list of analysis pipelines to generate mappings and document processors on. If empty, generate on all pipelines.
  - withExpandedPipelines
```
public ExpansionParams withExpandedPipelines(java.lang.String expandedPipelines)
```
  - setExpandedSearchLogics
```
public void setExpandedSearchLogics(java.lang.String expandedSearchLogics)
```
    A comma-separated list of search logics to generate prefix handlers, facets and hit metas on. If empty, generate on all search logics.
  - getExpandedSearchLogics
```
public java.lang.String getExpandedSearchLogics()
```
    A comma-separated list of search logics to generate prefix handlers, facets and hit metas on. If empty, generate on all search logics.
  - withExpandedSearchLogics
```
public ExpansionParams withExpandedSearchLogics(java.lang.String expandedSearchLogics)
```
  - makeCopy
```
public ExpansionParams makeCopy()
```
    Creates and returns a deep copy of this ExpansionParams.
  - readFrom
```
public static ExpansionParams readFrom(java.io.InputStream is)
                                throws javax.xml.bind.JAXBException
```
    Read this ExpansionParams 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 ExpansionParams as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static ExpansionParams fromString(java.lang.String s)
                                  throws javax.xml.bind.JAXBException,
                                         java.io.UnsupportedEncodingException
```
    String representation of this ExpansionParams.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this ExpansionParams.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this ExpansionParams.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class ExpansionParams

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

generateAnalysis

DEFAULT_GENERATE_ANALYSIS

generateIndexSchema

DEFAULT_GENERATE_INDEX_SCHEMA

generatePrefix

DEFAULT_GENERATE_PREFIX

generateFacet

DEFAULT_GENERATE_FACET

generateMeta

DEFAULT_GENERATE_META

expandedPipelines

expandedSearchLogics

Constructor Detail

ExpansionParams

ExpansionParams

Method Detail

setGenerateAnalysis

isGenerateAnalysis

withGenerateAnalysis

withGenerateAnalysis

setGenerateIndexSchema

isGenerateIndexSchema

withGenerateIndexSchema

withGenerateIndexSchema

setGeneratePrefix

isGeneratePrefix

withGeneratePrefix

withGeneratePrefix

setGenerateFacet

isGenerateFacet

withGenerateFacet

withGenerateFacet

setGenerateMeta

isGenerateMeta

withGenerateMeta

withGenerateMeta

setExpandedPipelines

getExpandedPipelines

withExpandedPipelines

setExpandedSearchLogics

getExpandedSearchLogics

withExpandedSearchLogics

makeCopy

readFrom

writeTo

fromString

toString

check