SearchTarget (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.search.v20.SearchTarget

All Implemented Interfaces:

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

Direct Known Subclasses:

LegacySearchTarget, LocalOnlySearchTarget, SimpleSearchTarget
```
public abstract class SearchTarget
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 int`	`DEFAULT_NB_VIRTUAL_PARTITION_PER_SLICE`
`static int`	`DEFAULT_WATCH_DOG_CONNECT_TIMEOUT_M_S`
`static int`	`DEFAULT_WATCH_DOG_READ_TIMEOUT_M_S`
`int`	`nbVirtualPartitionPerSlice`
`java.lang.String`	`targetName`
`int`	`watchDogConnectTimeoutMS`
`int`	`watchDogReadTimeoutMS`

Constructor Summary

Constructors
Constructor and Description

SearchTarget()

SearchTarget(SearchTarget o)
Copy constructor

Constructors
Constructor and Description
`SearchTarget()`
`SearchTarget(SearchTarget 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 SearchTarget.
`static SearchTarget`	`fromString(java.lang.String s)` String representation of this SearchTarget.
`int`	`getNbVirtualPartitionPerSlice()` Split every slices of the target in nbVirtualPartitionPerSlice virtual partitions.
`java.lang.String`	`getTargetName()` The name of this search target. This is the name to use in the search-api to reference a particular search target. Value must be a string matching '[A-Za-z0-9_]+'.
`int`	`getWatchDogConnectTimeoutMS()` Global 'connect' timeout for connection to index slices maintained by this search target. This is an advanced parameter that should generally not be modified.
`int`	`getWatchDogReadTimeoutMS()` Global 'read' timeout for connection to index slices maintainted by this search target. This is an advanced parameter that should generally not be modified.
`SearchTarget`	`makeCopy()`
`static SearchTarget`	`readFrom(java.io.InputStream is)` Read this SearchTarget from an XML fragment.
`void`	`setNbVirtualPartitionPerSlice(int nbVirtualPartitionPerSlice)` Split every slices of the target in nbVirtualPartitionPerSlice virtual partitions.
`void`	`setTargetName(java.lang.String targetName)` The name of this search target. This is the name to use in the search-api to reference a particular search target. Value must be a string matching '[A-Za-z0-9_]+'.
`void`	`setWatchDogConnectTimeoutMS(int watchDogConnectTimeoutMS)` Global 'connect' timeout for connection to index slices maintained by this search target. This is an advanced parameter that should generally not be modified.
`void`	`setWatchDogReadTimeoutMS(int watchDogReadTimeoutMS)` Global 'read' timeout for connection to index slices maintainted by this search target. This is an advanced parameter that should generally not be modified.
`java.lang.String`	`toString()` String representation of this SearchTarget.
`SearchTarget`	`withNbVirtualPartitionPerSlice(int nbVirtualPartitionPerSlice)`
`SearchTarget`	`withNbVirtualPartitionPerSlice(java.lang.Integer nbVirtualPartitionPerSlice)`
`SearchTarget`	`withTargetName(java.lang.String targetName)`
`SearchTarget`	`withWatchDogConnectTimeoutMS(int watchDogConnectTimeoutMS)`
`SearchTarget`	`withWatchDogConnectTimeoutMS(java.lang.Integer watchDogConnectTimeoutMS)`
`SearchTarget`	`withWatchDogReadTimeoutMS(int watchDogReadTimeoutMS)`
`SearchTarget`	`withWatchDogReadTimeoutMS(java.lang.Integer watchDogReadTimeoutMS)`
`void`	`writeTo(java.io.OutputStream os)`

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

- Field Detail
  - targetName
```
public java.lang.String targetName
```
  - watchDogConnectTimeoutMS
```
public int watchDogConnectTimeoutMS
```
  - DEFAULT_WATCH_DOG_CONNECT_TIMEOUT_M_S
```
public static final int DEFAULT_WATCH_DOG_CONNECT_TIMEOUT_M_S
```
    See Also:
    
    Constant Field Values
  - watchDogReadTimeoutMS
```
public int watchDogReadTimeoutMS
```
  - DEFAULT_WATCH_DOG_READ_TIMEOUT_M_S
```
public static final int DEFAULT_WATCH_DOG_READ_TIMEOUT_M_S
```
    See Also:
    
    Constant Field Values
  - nbVirtualPartitionPerSlice
```
public int nbVirtualPartitionPerSlice
```
  - DEFAULT_NB_VIRTUAL_PARTITION_PER_SLICE
```
public static final int DEFAULT_NB_VIRTUAL_PARTITION_PER_SLICE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchTarget
```
public SearchTarget()
```
  - SearchTarget
```
public SearchTarget(SearchTarget o)
```
    Copy constructor
- Method Detail
  - setTargetName
```
public void setTargetName(java.lang.String targetName)
```
    The name of this search target.
    This is the name to use in the search-api to reference a particular search target.
    
    Value must be a string matching '[A-Za-z0-9_]+'.
  - getTargetName
```
public java.lang.String getTargetName()
```
    The name of this search target.
    This is the name to use in the search-api to reference a particular search target.
    
    Value must be a string matching '[A-Za-z0-9_]+'.
  - withTargetName
```
public SearchTarget withTargetName(java.lang.String targetName)
```
  - setWatchDogConnectTimeoutMS
```
public void setWatchDogConnectTimeoutMS(int watchDogConnectTimeoutMS)
```
    Global 'connect' timeout for connection to index slices maintained by this search target.
    This is an advanced parameter that should generally not be modified.
  - getWatchDogConnectTimeoutMS
```
public int getWatchDogConnectTimeoutMS()
```
    Global 'connect' timeout for connection to index slices maintained by this search target.
    This is an advanced parameter that should generally not be modified.
  - withWatchDogConnectTimeoutMS
```
public SearchTarget withWatchDogConnectTimeoutMS(int watchDogConnectTimeoutMS)
```
  - withWatchDogConnectTimeoutMS
```
public SearchTarget withWatchDogConnectTimeoutMS(java.lang.Integer watchDogConnectTimeoutMS)
```
  - setWatchDogReadTimeoutMS
```
public void setWatchDogReadTimeoutMS(int watchDogReadTimeoutMS)
```
    Global 'read' timeout for connection to index slices maintainted by this search target.
    This is an advanced parameter that should generally not be modified.
  - getWatchDogReadTimeoutMS
```
public int getWatchDogReadTimeoutMS()
```
    Global 'read' timeout for connection to index slices maintainted by this search target.
    This is an advanced parameter that should generally not be modified.
  - withWatchDogReadTimeoutMS
```
public SearchTarget withWatchDogReadTimeoutMS(int watchDogReadTimeoutMS)
```
  - withWatchDogReadTimeoutMS
```
public SearchTarget withWatchDogReadTimeoutMS(java.lang.Integer watchDogReadTimeoutMS)
```
  - setNbVirtualPartitionPerSlice
```
public void setNbVirtualPartitionPerSlice(int nbVirtualPartitionPerSlice)
```
    Split every slices of the target in nbVirtualPartitionPerSlice virtual partitions. Emulate multislice behavior on a single slice, each partition acting on a subpart of the physical slice.
  - getNbVirtualPartitionPerSlice
```
public int getNbVirtualPartitionPerSlice()
```
    Split every slices of the target in nbVirtualPartitionPerSlice virtual partitions. Emulate multislice behavior on a single slice, each partition acting on a subpart of the physical slice.
  - withNbVirtualPartitionPerSlice
```
public SearchTarget withNbVirtualPartitionPerSlice(int nbVirtualPartitionPerSlice)
```
  - withNbVirtualPartitionPerSlice
```
public SearchTarget withNbVirtualPartitionPerSlice(java.lang.Integer nbVirtualPartitionPerSlice)
```
  - makeCopy
```
public SearchTarget makeCopy()
```
  - readFrom
```
public static SearchTarget readFrom(java.io.InputStream is)
                             throws javax.xml.bind.JAXBException
```
    Read this SearchTarget 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
```
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static SearchTarget fromString(java.lang.String s)
                               throws javax.xml.bind.JAXBException,
                                      java.io.UnsupportedEncodingException
```
    String representation of this SearchTarget.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this SearchTarget.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this SearchTarget.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class SearchTarget

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

targetName

watchDogConnectTimeoutMS

DEFAULT_WATCH_DOG_CONNECT_TIMEOUT_M_S

watchDogReadTimeoutMS

DEFAULT_WATCH_DOG_READ_TIMEOUT_M_S

nbVirtualPartitionPerSlice

DEFAULT_NB_VIRTUAL_PARTITION_PER_SLICE

Constructor Detail

SearchTarget

SearchTarget

Method Detail

setTargetName

getTargetName

withTargetName

setWatchDogConnectTimeoutMS

getWatchDogConnectTimeoutMS

withWatchDogConnectTimeoutMS

withWatchDogConnectTimeoutMS

setWatchDogReadTimeoutMS

getWatchDogReadTimeoutMS

withWatchDogReadTimeoutMS

withWatchDogReadTimeoutMS

setNbVirtualPartitionPerSlice

getNbVirtualPartitionPerSlice

withNbVirtualPartitionPerSlice

withNbVirtualPartitionPerSlice

makeCopy

readFrom

writeTo

fromString

toString

check