Package com.marklogic.client.ext.file

Class DefaultDocumentFileReader

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.client.ext.file.AbstractDocumentFileReader

com.marklogic.client.ext.file.DefaultDocumentFileReader

All Implemented Interfaces:

DocumentFileReader, java.nio.file.FileVisitor<java.nio.file.Path>

public class DefaultDocumentFileReader
extends AbstractDocumentFileReader
implements java.nio.file.FileVisitor<java.nio.file.Path>, DocumentFileReader

Non-threadsafe implementation that implements FileVisitor as a way of descending one or more file paths.

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
DefaultDocumentFileReader()	Calls initialize to instantiate some default DocumentFileProcessor objects.

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptPath(java.nio.file.Path path, java.nio.file.attribute.BasicFileAttributes attrs)
void	addFileFilter(java.io.FileFilter fileFilter)
protected DocumentFile	buildDocumentFile(java.nio.file.Path path, java.nio.file.Path currentRootPath)
protected java.nio.file.Path	constructPath(java.lang.String path)	The path is first wrapped in a File; this prevents a bug in Gradle when Gradle is run in daemon mode, where it will try to resolve the path from its daemon directory.
CollectionsFileDocumentFileProcessor	getCollectionsFileDocumentFileProcessor()	Deprecated. since 4.6.0, will be removed in 5.0.0
java.util.List<java.io.FileFilter>	getFileFilters()
PermissionsFileDocumentFileProcessor	getPermissionsFileDocumentFileProcessor()	Deprecated. since 4.6.0, will be removed in 5.0.0
protected void	initialize()
java.nio.file.FileVisitResult	postVisitDirectory(java.nio.file.Path dir, java.io.IOException exc)
java.nio.file.FileVisitResult	preVisitDirectory(java.nio.file.Path dir, java.nio.file.attribute.BasicFileAttributes attrs)
java.util.List<DocumentFile>	readDocumentFiles(java.lang.String... paths)	Walk the file tree at each of the given paths, applying any configured DocumentFileProcessor instances on each DocumentFile that is constructed by a File.
void	setFileFilters(java.util.List<java.io.FileFilter> fileFilters)
void	setUriPrefix(java.lang.String uriPrefix)
java.nio.file.FileVisitResult	visitFile(java.nio.file.Path path, java.nio.file.attribute.BasicFileAttributes attrs)
java.nio.file.FileVisitResult	visitFileFailed(java.nio.file.Path file, java.io.IOException exc)

Methods inherited from class com.marklogic.client.ext.file.AbstractDocumentFileReader

addDocumentFileProcessor, getDocumentFileProcessor, getDocumentFileProcessors, getFormatDocumentFileProcessor, isCatchProcessingError, processDocumentFile, setCatchProcessingError, setDocumentFileProcessors, setFormatDocumentFileProcessor

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

Constructor Detail

DefaultDocumentFileReader

public DefaultDocumentFileReader()

Calls initialize to instantiate some default DocumentFileProcessor objects.

Method Detail

readDocumentFiles

public java.util.List<DocumentFile> readDocumentFiles(java.lang.String... paths)

Walk the file tree at each of the given paths, applying any configured DocumentFileProcessor instances on each DocumentFile that is constructed by a File.

Specified by:

readDocumentFiles in interface DocumentFileReader

Parameters:

paths -

Returns:

list of DocumentFile objects in the given paths

constructPath

protected java.nio.file.Path constructPath(java.lang.String path)

The path is first wrapped in a File; this prevents a bug in Gradle when Gradle is run in daemon mode, where it will try to resolve the path from its daemon directory.

Parameters:

path -

Returns:

a Path object based on the given string path

preVisitDirectory

public java.nio.file.FileVisitResult preVisitDirectory(java.nio.file.Path dir,
                                                       java.nio.file.attribute.BasicFileAttributes attrs)
                                                throws java.io.IOException

Specified by:

preVisitDirectory in interface java.nio.file.FileVisitor<java.nio.file.Path>

Throws:

java.io.IOException

visitFileFailed

public java.nio.file.FileVisitResult visitFileFailed(java.nio.file.Path file,
                                                     java.io.IOException exc)

Specified by:

visitFileFailed in interface java.nio.file.FileVisitor<java.nio.file.Path>

postVisitDirectory

public java.nio.file.FileVisitResult postVisitDirectory(java.nio.file.Path dir,
                                                        java.io.IOException exc)
                                                 throws java.io.IOException

Specified by:

postVisitDirectory in interface java.nio.file.FileVisitor<java.nio.file.Path>

Throws:

java.io.IOException

visitFile

public java.nio.file.FileVisitResult visitFile(java.nio.file.Path path,
                                               java.nio.file.attribute.BasicFileAttributes attrs)

Specified by:

visitFile in interface java.nio.file.FileVisitor<java.nio.file.Path>

acceptPath

protected boolean acceptPath(java.nio.file.Path path,
                             java.nio.file.attribute.BasicFileAttributes attrs)

Parameters:

path -

attrs -

Returns:

false if any of the configured FileFilter objects do not accept the Path, else true

buildDocumentFile

protected DocumentFile buildDocumentFile(java.nio.file.Path path,
                                         java.nio.file.Path currentRootPath)

initialize

protected void initialize()

addFileFilter

public void addFileFilter(java.io.FileFilter fileFilter)

getFileFilters

public java.util.List<java.io.FileFilter> getFileFilters()

setFileFilters

public void setFileFilters(java.util.List<java.io.FileFilter> fileFilters)

setUriPrefix

public void setUriPrefix(java.lang.String uriPrefix)

getCollectionsFileDocumentFileProcessor

@Deprecated
public CollectionsFileDocumentFileProcessor getCollectionsFileDocumentFileProcessor()

Deprecated.

since 4.6.0, will be removed in 5.0.0

Returns:

getPermissionsFileDocumentFileProcessor

public PermissionsFileDocumentFileProcessor getPermissionsFileDocumentFileProcessor()

Deprecated.

since 4.6.0, will be removed in 5.0.0

Returns: