ISource (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.crawl.v10.ISource

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FeedFetcherSource, Source
```
public abstract class ISource
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ISource.MimeTypes` Java class for anonymous complex type.
`static class`	`ISource.QueryParameterBlacklist` Java class for anonymous complex type.
`static class`	`ISource.Rules` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.Boolean`	`defaultFollow`
`protected java.lang.Boolean`	`defaultFollowRoots`
`protected java.lang.Boolean`	`defaultIndex`
`protected java.lang.Boolean`	`disableConditionalGet`
`protected java.lang.Boolean`	`enableSimpleSiteCollapsing`
`protected java.lang.String`	`fetcher`
`protected java.util.List<KeyValue>`	`keyValue`
`protected ISource.MimeTypes`	`mimeTypes`
`protected java.lang.String`	`mimeTypesMode`
`protected java.lang.String`	`name`
`protected ISource.QueryParameterBlacklist`	`queryParameterBlacklist`
`protected ISource.Rules`	`rules`
`protected java.lang.Long`	`simpleSiteCollapsingDepth`

Constructor Summary

Constructors
Constructor and Description

ISource()
Creates a new ISource instance.

ISource(ISource o)
Creates a new ISource instance by deeply copying a given ISource instance.

Constructors
Constructor and Description
`ISource()` Creates a new `ISource` instance.
`ISource(ISource o)` Creates a new `ISource` instance by deeply copying a given `ISource` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ISource`	`clone()` Creates and returns a deep copy of this object.
`java.lang.String`	`getFetcher()` Which fetcher to use with urls from this source.
`java.util.List<KeyValue>`	`getKeyValue()` Gets the value of the keyValue property.
`ISource.MimeTypes`	`getMimeTypes()` Gets the value of the mimeTypes property.
`java.lang.String`	`getMimeTypesMode()` Mime types white/black list (default: exclude)
`java.lang.String`	`getName()` The source name.
`ISource.QueryParameterBlacklist`	`getQueryParameterBlacklist()` Query parameter blacklist.
`ISource.Rules`	`getRules()` A list of rules to define which urls are crawled, indexed and followed.
`long`	`getSimpleSiteCollapsingDepth()` How many path segments to use to generate the site collapsing ID.
`boolean`	`isDefaultFollow()` Whether to follow by default when a url matches no follow rule.
`boolean`	`isDefaultFollowRoots()` Whether to automatically follow root urls (default: true)
`boolean`	`isDefaultIndex()` Whether to index by default when a url matches no index rule.
`boolean`	`isDisableConditionalGet()` Whether to always fetch documents, even if the server tells it has not changed.
`boolean`	`isEnableSimpleSiteCollapsing()` Whether to generate a site ID suitable for document collapsing.
`void`	`setDefaultFollow(java.lang.Boolean value)` Sets the value of the defaultFollow property.
`void`	`setDefaultFollowRoots(java.lang.Boolean value)` Sets the value of the defaultFollowRoots property.
`void`	`setDefaultIndex(java.lang.Boolean value)` Sets the value of the defaultIndex property.
`void`	`setDisableConditionalGet(java.lang.Boolean value)` Sets the value of the disableConditionalGet property.
`void`	`setEnableSimpleSiteCollapsing(java.lang.Boolean value)` Sets the value of the enableSimpleSiteCollapsing property.
`void`	`setFetcher(java.lang.String value)` Sets the value of the fetcher property.
`void`	`setMimeTypes(ISource.MimeTypes value)` Sets the value of the mimeTypes property.
`void`	`setMimeTypesMode(java.lang.String value)` Sets the value of the mimeTypesMode property.
`void`	`setName(java.lang.String value)` Sets the value of the name property.
`void`	`setQueryParameterBlacklist(ISource.QueryParameterBlacklist value)` Sets the value of the queryParameterBlacklist property.
`void`	`setRules(ISource.Rules value)` Sets the value of the rules property.
`void`	`setSimpleSiteCollapsingDepth(java.lang.Long value)` Sets the value of the simpleSiteCollapsingDepth property.
`ISource`	`withDefaultFollow(java.lang.Boolean value)`
`ISource`	`withDefaultFollowRoots(java.lang.Boolean value)`
`ISource`	`withDefaultIndex(java.lang.Boolean value)`
`ISource`	`withDisableConditionalGet(java.lang.Boolean value)`
`ISource`	`withEnableSimpleSiteCollapsing(java.lang.Boolean value)`
`ISource`	`withFetcher(java.lang.String value)`
`ISource`	`withKeyValue(java.util.Collection<KeyValue> values)`
`ISource`	`withKeyValue(KeyValue... values)`
`ISource`	`withMimeTypes(ISource.MimeTypes value)`
`ISource`	`withMimeTypesMode(java.lang.String value)`
`ISource`	`withName(java.lang.String value)`
`ISource`	`withQueryParameterBlacklist(ISource.QueryParameterBlacklist value)`
`ISource`	`withRules(ISource.Rules value)`
`ISource`	`withSimpleSiteCollapsingDepth(java.lang.Long value)`

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

- Field Detail
  - keyValue
```
protected java.util.List<KeyValue> keyValue
```
  - rules
```
protected ISource.Rules rules
```
  - mimeTypes
```
protected ISource.MimeTypes mimeTypes
```
  - queryParameterBlacklist
```
protected ISource.QueryParameterBlacklist queryParameterBlacklist
```
  - name
```
protected java.lang.String name
```
  - fetcher
```
protected java.lang.String fetcher
```
  - disableConditionalGet
```
protected java.lang.Boolean disableConditionalGet
```
  - defaultIndex
```
protected java.lang.Boolean defaultIndex
```
  - defaultFollow
```
protected java.lang.Boolean defaultFollow
```
  - defaultFollowRoots
```
protected java.lang.Boolean defaultFollowRoots
```
  - enableSimpleSiteCollapsing
```
protected java.lang.Boolean enableSimpleSiteCollapsing
```
  - simpleSiteCollapsingDepth
```
protected java.lang.Long simpleSiteCollapsingDepth
```
  - mimeTypesMode
```
protected java.lang.String mimeTypesMode
```
- Constructor Detail
  - ISource
```
public ISource()
```
    Creates a new ISource instance.
  - ISource
```
public ISource(ISource o)
```
    Creates a new ISource instance by deeply copying a given ISource instance.
    
    Parameters:
    
    o - The instance to copy.
    
    Throws:
    
    java.lang.NullPointerException - if o is null.
- Method Detail
  - getKeyValue
```
public java.util.List<KeyValue> getKeyValue()
```
    Gets the value of the keyValue property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the keyValue property.
    For example, to add a new item, do as follows:
```
    getKeyValue().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list KeyValue
  - getRules
```
public ISource.Rules getRules()
```
    A list of rules to define which urls are crawled, indexed and followed.
    
    Returns:
    
    possible object is ISource.Rules
  - setRules
```
public void setRules(ISource.Rules value)
```
    Sets the value of the rules property.
    
    Parameters:
    
    value - allowed object is ISource.Rules
  - getMimeTypes
```
public ISource.MimeTypes getMimeTypes()
```
    Gets the value of the mimeTypes property.
    
    Returns:
    
    possible object is ISource.MimeTypes
  - setMimeTypes
```
public void setMimeTypes(ISource.MimeTypes value)
```
    Sets the value of the mimeTypes property.
    
    Parameters:
    
    value - allowed object is ISource.MimeTypes
  - getQueryParameterBlacklist
```
public ISource.QueryParameterBlacklist getQueryParameterBlacklist()
```
    Query parameter blacklist. URLs with a query part containing a parameter in this list are ignored (noindex, nofollow).
    
    Returns:
    
    possible object is ISource.QueryParameterBlacklist
  - setQueryParameterBlacklist
```
public void setQueryParameterBlacklist(ISource.QueryParameterBlacklist value)
```
    Sets the value of the queryParameterBlacklist property.
    
    Parameters:
    
    value - allowed object is ISource.QueryParameterBlacklist
  - getName
```
public java.lang.String getName()
```
    The source name. It must be unique across all connector names. (default: null)
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(java.lang.String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getFetcher
```
public java.lang.String getFetcher()
```
    Which fetcher to use with urls from this source. (default: null)
    
    Returns:
    
    possible object is String
  - setFetcher
```
public void setFetcher(java.lang.String value)
```
    Sets the value of the fetcher property.
    
    Parameters:
    
    value - allowed object is String
  - isDisableConditionalGet
```
public boolean isDisableConditionalGet()
```
    Whether to always fetch documents, even if the server tells it has not changed. (default: false)
    
    Returns:
    
    possible object is Boolean
  - setDisableConditionalGet
```
public void setDisableConditionalGet(java.lang.Boolean value)
```
    Sets the value of the disableConditionalGet property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDefaultIndex
```
public boolean isDefaultIndex()
```
    Whether to index by default when a url matches no index rule. (default: false)
    
    Returns:
    
    possible object is Boolean
  - setDefaultIndex
```
public void setDefaultIndex(java.lang.Boolean value)
```
    Sets the value of the defaultIndex property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDefaultFollow
```
public boolean isDefaultFollow()
```
    Whether to follow by default when a url matches no follow rule. (default: false)
    
    Returns:
    
    possible object is Boolean
  - setDefaultFollow
```
public void setDefaultFollow(java.lang.Boolean value)
```
    Sets the value of the defaultFollow property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDefaultFollowRoots
```
public boolean isDefaultFollowRoots()
```
    Whether to automatically follow root urls (default: true)
    
    Returns:
    
    possible object is Boolean
  - setDefaultFollowRoots
```
public void setDefaultFollowRoots(java.lang.Boolean value)
```
    Sets the value of the defaultFollowRoots property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isEnableSimpleSiteCollapsing
```
public boolean isEnableSimpleSiteCollapsing()
```
    Whether to generate a site ID suitable for document collapsing. (default: true)
    
    Returns:
    
    possible object is Boolean
  - setEnableSimpleSiteCollapsing
```
public void setEnableSimpleSiteCollapsing(java.lang.Boolean value)
```
    Sets the value of the enableSimpleSiteCollapsing property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getSimpleSiteCollapsingDepth
```
public long getSimpleSiteCollapsingDepth()
```
    How many path segments to use to generate the site collapsing ID. (default: 0)
    
    Returns:
    
    possible object is Long
  - setSimpleSiteCollapsingDepth
```
public void setSimpleSiteCollapsingDepth(java.lang.Long value)
```
    Sets the value of the simpleSiteCollapsingDepth property.
    
    Parameters:
    
    value - allowed object is Long
  - getMimeTypesMode
```
public java.lang.String getMimeTypesMode()
```
    Mime types white/black list (default: exclude)
    
    Returns:
    
    possible object is String
  - setMimeTypesMode
```
public void setMimeTypesMode(java.lang.String value)
```
    Sets the value of the mimeTypesMode property.
    
    Parameters:
    
    value - allowed object is String
  - withKeyValue
```
public ISource withKeyValue(KeyValue... values)
```
  - withKeyValue
```
public ISource withKeyValue(java.util.Collection<KeyValue> values)
```
  - withRules
```
public ISource withRules(ISource.Rules value)
```
  - withMimeTypes
```
public ISource withMimeTypes(ISource.MimeTypes value)
```
  - withQueryParameterBlacklist
```
public ISource withQueryParameterBlacklist(ISource.QueryParameterBlacklist value)
```
  - withName
```
public ISource withName(java.lang.String value)
```
  - withFetcher
```
public ISource withFetcher(java.lang.String value)
```
  - withDisableConditionalGet
```
public ISource withDisableConditionalGet(java.lang.Boolean value)
```
  - withDefaultIndex
```
public ISource withDefaultIndex(java.lang.Boolean value)
```
  - withDefaultFollow
```
public ISource withDefaultFollow(java.lang.Boolean value)
```
  - withDefaultFollowRoots
```
public ISource withDefaultFollowRoots(java.lang.Boolean value)
```
  - withEnableSimpleSiteCollapsing
```
public ISource withEnableSimpleSiteCollapsing(java.lang.Boolean value)
```
  - withSimpleSiteCollapsingDepth
```
public ISource withSimpleSiteCollapsingDepth(java.lang.Long value)
```
  - withMimeTypesMode
```
public ISource withMimeTypesMode(java.lang.String value)
```
  - clone
```
public ISource clone()
```
    Creates and returns a deep copy of this object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    A deep copy of this object.

Class ISource

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

keyValue

rules

mimeTypes

queryParameterBlacklist

name

fetcher

disableConditionalGet

defaultIndex

defaultFollow

defaultFollowRoots

enableSimpleSiteCollapsing

simpleSiteCollapsingDepth

mimeTypesMode

Constructor Detail

ISource

ISource

Method Detail

getKeyValue

getRules

setRules

getMimeTypes

setMimeTypes

getQueryParameterBlacklist

setQueryParameterBlacklist

getName

setName

getFetcher

setFetcher

isDisableConditionalGet

setDisableConditionalGet

isDefaultIndex

setDefaultIndex

isDefaultFollow

setDefaultFollow

isDefaultFollowRoots

setDefaultFollowRoots

isEnableSimpleSiteCollapsing

setEnableSimpleSiteCollapsing

getSimpleSiteCollapsingDepth

setSimpleSiteCollapsingDepth

getMimeTypesMode

setMimeTypesMode

withKeyValue

withKeyValue

withRules

withMimeTypes

withQueryParameterBlacklist

withName

withFetcher

withDisableConditionalGet

withDefaultIndex

withDefaultFollow

withDefaultFollowRoots

withEnableSimpleSiteCollapsing

withSimpleSiteCollapsingDepth

withMimeTypesMode

clone