Package com.marklogic.client.ext.file

Class PropertiesDrivenDocumentFileProcessor

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.client.ext.file.PropertiesDrivenDocumentFileProcessor

All Implemented Interfaces:

DocumentFileProcessor, SupportsTokenReplacer, java.io.FileFilter

Direct Known Subclasses:

CollectionsFileDocumentFileProcessor, PermissionsFileDocumentFileProcessor

public abstract class PropertiesDrivenDocumentFileProcessor
extends LoggingObject
implements DocumentFileProcessor, java.io.FileFilter, SupportsTokenReplacer

Base class for processors that look for a special file in each directory and intend to perform some processing based on the contents of that file. By default, that special file is NOT loaded into MarkLogic.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	WILDCARD_KEY

Fields inherited from class com.marklogic.client.ext.helper.LoggingObject

logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PropertiesDrivenDocumentFileProcessor(java.lang.String propertiesFilename)

Method Summary

Modifier and Type	Method	Description
boolean	accept(java.io.File file)
protected java.util.Properties	getProperties()
java.lang.String	getPropertiesFilename()
protected java.lang.String	getPropertyValue(java.util.Properties properties, java.lang.String propertyName)
protected TokenReplacer	getTokenReplacer()
protected java.util.Properties	loadProperties(java.io.File propertiesFile)
DocumentFile	processDocumentFile(DocumentFile documentFile)
protected abstract void	processProperties(DocumentFile documentFile, java.util.Properties properties)
protected void	setProperties(java.util.Properties properties)
void	setTokenReplacer(TokenReplacer tokenReplacer)

Methods inherited from class com.marklogic.client.ext.helper.LoggingObject

format

Methods inherited from class java.lang.Object

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

Field Detail

WILDCARD_KEY

protected static final java.lang.String WILDCARD_KEY

See Also:

Constant Field Values

Constructor Detail

PropertiesDrivenDocumentFileProcessor

protected PropertiesDrivenDocumentFileProcessor(java.lang.String propertiesFilename)

Method Detail

accept

public boolean accept(java.io.File file)

Specified by:

accept in interface java.io.FileFilter

processDocumentFile

public DocumentFile processDocumentFile(DocumentFile documentFile)

Specified by:

processDocumentFile in interface DocumentFileProcessor

Parameters:

documentFile -

Returns:

null if the file is not accepted, else the incoming DocumentFile

processProperties

protected abstract void processProperties(DocumentFile documentFile,
                                          java.util.Properties properties)

loadProperties

protected java.util.Properties loadProperties(java.io.File propertiesFile)
                                       throws java.io.IOException

Throws:

java.io.IOException

getPropertyValue

protected java.lang.String getPropertyValue(java.util.Properties properties,
                                            java.lang.String propertyName)

getPropertiesFilename

public java.lang.String getPropertiesFilename()

setTokenReplacer

public void setTokenReplacer(TokenReplacer tokenReplacer)

Specified by:

setTokenReplacer in interface SupportsTokenReplacer

getTokenReplacer

protected TokenReplacer getTokenReplacer()

setProperties

protected void setProperties(java.util.Properties properties)

getProperties

protected java.util.Properties getProperties()