com.groupdocs.search.common

Class AttributeChangeBatch

java.lang.Object

com.groupdocs.search.common.AttributeChangeBatch

public class AttributeChangeBatch
extends Object

Represents a container for attribute changes.

Learn more

• Document attributes
• Document filtering in search result

Constructor Summary

Constructors

Modifier	Constructor and Description
	AttributeChangeBatch() Initializes a new instance of the AttributeChangeBatch class.
	AttributeChangeBatch(Object data) Initializes a new instance of the AttributeChangeBatch class.
protected	AttributeChangeBatch(Object state1, Object state2) Initializes a new instance of the AttributeChangeBatch class.

Method Summary

Modifier and Type	Method and Description
void	add(String[] paths, String... attributes) Adds the specified attributes to the specified indexed documents.
void	add(String path, String... attributes) Adds the specified attributes to the specified indexed document.
void	addToAll(String... attributes) Adds the specified attributes to all documents in the index.
void	clear() Removes all attributes from all documents in the index.
Object	getCore()
void	remove(String[] paths, String... attributes) Removes the specified attributes from the specified indexed documents.
void	remove(String path, String... attributes) Removes the specified attributes from the specified indexed document.
void	removeAll(String path) Removes all attributes from the specified indexed document.
void	removeAll(String[] paths) Removes all attributes from the specified indexed documents.
void	removeFromAll(String... attributes) Removes the specified attributes from all documents in the index.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeChangeBatch

public AttributeChangeBatch()

Initializes a new instance of the AttributeChangeBatch class.

AttributeChangeBatch

public AttributeChangeBatch(Object data)

Initializes a new instance of the AttributeChangeBatch class.

Parameters:

data - The serialized data.

AttributeChangeBatch

protected AttributeChangeBatch(Object state1,
                               Object state2)

Initializes a new instance of the AttributeChangeBatch class.

Parameters:

state1 - The state 1.

state2 - The state 2.

Method Detail

add

public void add(String[] paths,
                String... attributes)

Adds the specified attributes to the specified indexed documents.

Parameters:

paths - The documents paths.

attributes - The attributes to add.

add

public void add(String path,
                String... attributes)

Adds the specified attributes to the specified indexed document.

Parameters:

path - The document path.

attributes - The attributes to add.

addToAll

public void addToAll(String... attributes)

Adds the specified attributes to all documents in the index.

Parameters:

attributes - The attributes to add.

clear

public void clear()

Removes all attributes from all documents in the index.

getCore

public Object getCore()

remove

public void remove(String[] paths,
                   String... attributes)

Removes the specified attributes from the specified indexed documents.

Parameters:

paths - The documents paths.

attributes - The attributes to remove.

remove

public void remove(String path,
                   String... attributes)

Removes the specified attributes from the specified indexed document.

Parameters:

path - The document path.

attributes - The attributes to remove.

removeAll

public void removeAll(String path)

Removes all attributes from the specified indexed document.

Parameters:

path - The document path.

removeAll

public void removeAll(String[] paths)

Removes all attributes from the specified indexed documents.

Parameters:

paths - The documents paths.

removeFromAll

public void removeFromAll(String... attributes)

Removes the specified attributes from all documents in the index.

Parameters:

attributes - The attributes to remove.