org.apache.tika.batch.fs

Class FSFileResource

java.lang.Object

org.apache.tika.batch.fs.FSFileResource

All Implemented Interfaces:

FileResource

public class FSFileResource
extends java.lang.Object
implements FileResource

FileSystem(FS)Resource wraps a file name.

This class automatically sets the following keys in Metadata:

• Metadata.RESOURCE_NAME_KEY (file name)
• Metadata.CONTENT_LENGTH
• FSProperties.FS_REL_PATH
• FileResource.FILE_EXTENSION

,

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.file.Path	fullPath
private Metadata	metadata
private java.lang.String	relativePath

Fields inherited from interface org.apache.tika.batch.FileResource

FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
FSFileResource(java.io.File inputRoot, java.io.File fullPath) Deprecated. to be removed in Tika 2.0
FSFileResource(java.nio.file.Path inputRoot, java.nio.file.Path fullPath) Constructor

Method Summary

Modifier and Type	Method and Description
private java.lang.String	getExtension(java.nio.file.Path fullPath) Simple extension extractor that takes whatever comes after the last period in the path.
Metadata	getMetadata() This gets the metadata available before the parsing of the file.
java.lang.String	getResourceId() This is only used in logging to identify which file may have caused problems.
java.io.InputStream	openInputStream()

Methods inherited from class java.lang.Object

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

Field Detail

fullPath

private final java.nio.file.Path fullPath

relativePath

private final java.lang.String relativePath

metadata

private final Metadata metadata

Constructor Detail

FSFileResource

@Deprecated
public FSFileResource(java.io.File inputRoot,
                                  java.io.File fullPath)

Deprecated. to be removed in Tika 2.0

Parameters:

inputRoot -

fullPath -

See Also:

FSFileResource(Path, Path)

FSFileResource

public FSFileResource(java.nio.file.Path inputRoot,
                      java.nio.file.Path fullPath)

Constructor

Parameters:

inputRoot - the input root for the file

fullPath - the full path to the file

Throws:

java.lang.IllegalArgumentException - if the fullPath is not a child of inputRoot

Method Detail

getExtension

private java.lang.String getExtension(java.nio.file.Path fullPath)

Simple extension extractor that takes whatever comes after the last period in the path. It returns a lowercased version of the "extension."

If there is no period, it returns an empty string.

Parameters:

fullPath - full path from which to try to find an extension

Returns:

the lowercased extension or an empty string

getResourceId

public java.lang.String getResourceId()

Description copied from interface: FileResource

This is only used in logging to identify which file may have caused problems. While it is probably best to use unique ids for the sake of debugging, it is not necessary that the ids be unique. This id is never used as a hashkey by the batch processors, for example.

Specified by:

getResourceId in interface FileResource

Returns:

file's relativePath

getMetadata

public Metadata getMetadata()

Description copied from interface: FileResource

This gets the metadata available before the parsing of the file. This will typically be "external" metadata: file name, file size, file location, data stream, etc. That is, things that are known about the file from outside information, not file-internal metadata.

Specified by:

getMetadata in interface FileResource

Returns:

Metadata

openInputStream

public java.io.InputStream openInputStream()
                                    throws java.io.IOException

Specified by:

openInputStream in interface FileResource

Returns:

an InputStream for the FileResource

Throws:

java.io.IOException