org.apache.drill.exec.store.dfs

Class FileSelection

java.lang.Object

org.apache.drill.exec.store.dfs.FileSelection

public class FileSelection
extends Object

Jackson serializable description of a file selection.

Field Summary

Fields

Modifier and Type	Field and Description
String	cacheFileRoot root path for the metadata cache file (if any)
List<String>	files
String	selectionRoot root path for the selections

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSelection(FileSelection selection) Copy constructor for convenience.
	FileSelection(List<org.apache.hadoop.fs.FileStatus> statuses, List<String> files, String selectionRoot) Creates a selection out of given file statuses/files and selection root.
	FileSelection(List<org.apache.hadoop.fs.FileStatus> statuses, List<String> files, String selectionRoot, String cacheFileRoot, boolean wasAllPartitionsPruned)
	FileSelection(List<org.apache.hadoop.fs.FileStatus> statuses, List<String> files, String selectionRoot, String cacheFileRoot, boolean wasAllPartitionsPruned, org.apache.drill.exec.store.dfs.FileSelection.StatusType dirStatus)

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkBackPaths(String parent, String combinedPath, String subpath) Check if the path is a valid sub path under the parent after removing backpaths.
boolean	containsDirectories(DrillFileSystem fs)
static FileSelection	create(DrillFileSystem fs, String parent, String path, boolean allowAccessOutsideWorkspace)
static FileSelection	create(List<org.apache.hadoop.fs.FileStatus> statuses, List<String> files, String root)
static FileSelection	create(List<org.apache.hadoop.fs.FileStatus> statuses, List<String> files, String root, String cacheFileRoot, boolean wasAllPartitionsPruned) Creates a selection with the given file statuses/files and selection root.
static FileSelection	createFromDirectories(List<String> dirPaths, FileSelection selection, String cacheFileRoot)
String	getCacheFileRoot()
org.apache.drill.exec.store.dfs.FileSelection.StatusType	getDirStatus()
List<String>	getFiles()
List<org.apache.hadoop.fs.FileStatus>	getFileStatuses()
org.apache.hadoop.fs.FileStatus	getFirstPath(DrillFileSystem fs)
MetadataContext	getMetaContext()
String	getSelectionRoot()
List<org.apache.hadoop.fs.FileStatus>	getStatuses(DrillFileSystem fs)
boolean	hadWildcard()
boolean	isExpandedFully()
boolean	isExpandedPartial()
FileSelection	minusDirectories(DrillFileSystem fs)
static String	removeLeadingSlash(String path)
void	setExpandedFully()
void	setExpandedPartial()
void	setHadWildcard(boolean wc)
void	setMetaContext(MetadataContext context)
boolean	supportDirPrunig()
String	toString()
boolean	wasAllPartitionsPruned()

Methods inherited from class java.lang.Object

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

Field Detail

files

public List<String> files

selectionRoot

public final String selectionRoot

root path for the selections

cacheFileRoot

public final String cacheFileRoot

root path for the metadata cache file (if any)

Constructor Detail

FileSelection

public FileSelection(List<org.apache.hadoop.fs.FileStatus> statuses,
             List<String> files,
             String selectionRoot)

Creates a selection out of given file statuses/files and selection root.

Parameters:

statuses - list of file statuses

files - list of files

selectionRoot - root path for selections

FileSelection

public FileSelection(List<org.apache.hadoop.fs.FileStatus> statuses,
             List<String> files,
             String selectionRoot,
             String cacheFileRoot,
             boolean wasAllPartitionsPruned)

FileSelection

public FileSelection(List<org.apache.hadoop.fs.FileStatus> statuses,
             List<String> files,
             String selectionRoot,
             String cacheFileRoot,
             boolean wasAllPartitionsPruned,
             org.apache.drill.exec.store.dfs.FileSelection.StatusType dirStatus)

FileSelection

protected FileSelection(FileSelection selection)

Copy constructor for convenience.

Method Detail

getSelectionRoot

public String getSelectionRoot()

getStatuses

public List<org.apache.hadoop.fs.FileStatus> getStatuses(DrillFileSystem fs)
                                                  throws IOException

Throws:

IOException

getFiles

public List<String> getFiles()

containsDirectories

public boolean containsDirectories(DrillFileSystem fs)
                            throws IOException

Throws:

IOException

minusDirectories

public FileSelection minusDirectories(DrillFileSystem fs)
                               throws IOException

Throws:

IOException

getFirstPath

public org.apache.hadoop.fs.FileStatus getFirstPath(DrillFileSystem fs)
                                             throws IOException

Throws:

IOException

setExpandedFully

public void setExpandedFully()

isExpandedFully

public boolean isExpandedFully()

setExpandedPartial

public void setExpandedPartial()

isExpandedPartial

public boolean isExpandedPartial()

getDirStatus

public org.apache.drill.exec.store.dfs.FileSelection.StatusType getDirStatus()

wasAllPartitionsPruned

public boolean wasAllPartitionsPruned()

create

public static FileSelection create(DrillFileSystem fs,
                   String parent,
                   String path,
                   boolean allowAccessOutsideWorkspace)
                            throws IOException

Throws:

IOException

create

public static FileSelection create(List<org.apache.hadoop.fs.FileStatus> statuses,
                   List<String> files,
                   String root,
                   String cacheFileRoot,
                   boolean wasAllPartitionsPruned)

Creates a selection with the given file statuses/files and selection root.

Parameters:

statuses - list of file statuses

files - list of files

root - root path for selections

cacheFileRoot - root path for metadata cache (null for no metadata cache)

Returns:

null if creation of FileSelection fails with an IllegalArgumentException otherwise a new selection.

See Also:

FileSelection(List, List, String)

create

public static FileSelection create(List<org.apache.hadoop.fs.FileStatus> statuses,
                   List<String> files,
                   String root)

createFromDirectories

public static FileSelection createFromDirectories(List<String> dirPaths,
                                  FileSelection selection,
                                  String cacheFileRoot)

removeLeadingSlash

public static String removeLeadingSlash(String path)

checkBackPaths

public static void checkBackPaths(String parent,
                  String combinedPath,
                  String subpath)

Check if the path is a valid sub path under the parent after removing backpaths. Throw an exception if it is not. We pass subpath in as a parameter only for the error message

Parameters:

parent - The parent path (the workspace directory).

combinedPath - The workspace directory and (relative) subpath path combined.

subpath - For error message only, the subpath

getFileStatuses

public List<org.apache.hadoop.fs.FileStatus> getFileStatuses()

supportDirPrunig

public boolean supportDirPrunig()

setHadWildcard

public void setHadWildcard(boolean wc)

hadWildcard

public boolean hadWildcard()

getCacheFileRoot

public String getCacheFileRoot()

setMetaContext

public void setMetaContext(MetadataContext context)

getMetaContext

public MetadataContext getMetaContext()

toString

public String toString()

Overrides:

toString in class Object