com.norconex.committer.core.impl

Class FileSystemCommitter

java.lang.Object

com.norconex.committer.core.impl.FileSystemCommitter

All Implemented Interfaces:

ICommitter, com.norconex.commons.lang.config.IXMLConfigurable

public class FileSystemCommitter
extends Object
implements ICommitter, com.norconex.commons.lang.config.IXMLConfigurable

Commits a copy of files on the filesystem. Files are directly saved to the specified directory (no queuing or commit). Useful for troubleshooting, or used as a file-based queue implementation by other committers.

XML configuration usage:

  <committer class="com.norconex.committer.core.impl.FileSystemCommitter">
      <directory>(path where to save files)</directory>
  </committer>
 

Author:

Pascal Essiembre

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DIRECTORY Default committer directory
static String	EXTENSION_CONTENT
static String	EXTENSION_METADATA
static String	EXTENSION_REFERENCE
static String	FILE_SUFFIX_ADD
static String	FILE_SUFFIX_REMOVE

Constructor Summary

Constructors

Constructor and Description
FileSystemCommitter()

Method Summary

Modifier and Type	Method and Description
void	add(String reference, InputStream content, com.norconex.commons.lang.map.Properties metadata) Adds a new or modified document to the target destination.
void	commit() Commits documents.
boolean	equals(Object obj)
File	getAddDir() Deprecated. since 2.0.1
String	getDirectory() Gets the directory where files are committed.
File	getRemoveDir() Deprecated. since 2.0.1
int	hashCode()
void	loadFromXML(Reader in)
void	remove(String reference, com.norconex.commons.lang.map.Properties metadata) Removes a document from the target destination.
void	saveToXML(Writer out)
void	setDirectory(String directory) Sets the directory where files are committed.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_DIRECTORY

public static final String DEFAULT_DIRECTORY

Default committer directory

See Also:

Constant Field Values

EXTENSION_CONTENT

public static final String EXTENSION_CONTENT

See Also:

Constant Field Values

EXTENSION_METADATA

public static final String EXTENSION_METADATA

See Also:

Constant Field Values

EXTENSION_REFERENCE

public static final String EXTENSION_REFERENCE

See Also:

Constant Field Values

FILE_SUFFIX_ADD

public static final String FILE_SUFFIX_ADD

See Also:

Constant Field Values

FILE_SUFFIX_REMOVE

public static final String FILE_SUFFIX_REMOVE

See Also:

Constant Field Values

Constructor Detail

FileSystemCommitter

public FileSystemCommitter()

Method Detail

getDirectory

public String getDirectory()

Gets the directory where files are committed.

Returns:

directory

setDirectory

public void setDirectory(String directory)

Sets the directory where files are committed.

Parameters:

directory - the directory

add

public void add(String reference,
                InputStream content,
                com.norconex.commons.lang.map.Properties metadata)

Description copied from interface: ICommitter

Adds a new or modified document to the target destination. Implementations may decide to queue the addition request instead until commit is called, or a certain threshold is reached.

Specified by:

add in interface ICommitter

Parameters:

reference - document reference (e.g. URL)

content - document content

metadata - document metadata

remove

public void remove(String reference,
                   com.norconex.commons.lang.map.Properties metadata)

Description copied from interface: ICommitter

Removes a document from the target destination. Implementations may decide to queue the removal request instead until commit is called, or a certain threshold is reached.

Specified by:

remove in interface ICommitter

Parameters:

reference - document reference (e.g. URL)

metadata - document metadata

commit

public void commit()

Description copied from interface: ICommitter

Commits documents. Effectively apply the additions and removals. May not be necessary for some implementations.

Specified by:

commit in interface ICommitter

getAddDir

@Deprecated
public File getAddDir()

Deprecated. since 2.0.1

Gets the directory where documents to be added are stored.

Returns:

directory

getRemoveDir

@Deprecated
public File getRemoveDir()

Deprecated. since 2.0.1

Gets the directory where documents to be removed are stored.

Returns:

directory

loadFromXML

public void loadFromXML(Reader in)

Specified by:

loadFromXML in interface com.norconex.commons.lang.config.IXMLConfigurable

saveToXML

public void saveToXML(Writer out)
               throws IOException

Specified by:

saveToXML in interface com.norconex.commons.lang.config.IXMLConfigurable

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object