io.lakefs.utils

Class ObjectLocation

java.lang.Object

io.lakefs.utils.ObjectLocation

public class ObjectLocation
extends Object

Constructor Summary

Constructors

Constructor and Description
ObjectLocation()
ObjectLocation(String scheme, String repository, String ref)
ObjectLocation(String scheme, String repository, String ref, String path)

Method Summary

Modifier and Type	Method and Description
ObjectLocation	clone()
boolean	equals(Object obj)
static String	formatPath(String scheme, String repository, String ref)
static String	formatPath(String scheme, String repository, String ref, String path)
ObjectLocation	getParent()
String	getPath()
String	getRef()
String	getRepository()
String	getScheme()
boolean	isValidPath()
boolean	onSameBranch(ObjectLocation otherObjLoc) Checks if an ObjectLocation is on the same branch.
static ObjectLocation	pathToObjectLocation(org.apache.hadoop.fs.Path path) Returns Location with repository, ref and path used by lakeFS based on filesystem path.
static ObjectLocation	pathToObjectLocation(org.apache.hadoop.fs.Path workingDirectory, org.apache.hadoop.fs.Path path) Returns Location with repository, ref and path used by lakeFS based on filesystem path.
void	setPath(String path)
void	setRef(String ref)
void	setRepository(String repository)
void	setScheme(String scheme)
ObjectLocation	toDirectory()
org.apache.hadoop.fs.Path	toFSPath()
String	toRefString()
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectLocation

public ObjectLocation()

ObjectLocation

public ObjectLocation(String scheme,
                      String repository,
                      String ref)

ObjectLocation

public ObjectLocation(String scheme,
                      String repository,
                      String ref,
                      String path)

Method Detail

pathToObjectLocation

@Nonnull
public static ObjectLocation pathToObjectLocation(org.apache.hadoop.fs.Path workingDirectory,
                                                           org.apache.hadoop.fs.Path path)

Returns Location with repository, ref and path used by lakeFS based on filesystem path.

Parameters:

workingDirectory - used if path is local.

path - to extract information from.

Returns:

lakeFS Location with repository, ref and path

pathToObjectLocation

@Nonnull
public static ObjectLocation pathToObjectLocation(org.apache.hadoop.fs.Path path)

Returns Location with repository, ref and path used by lakeFS based on filesystem path.

Parameters:

path - to extract information from.

Returns:

lakeFS Location with repository, ref and path

formatPath

public static String formatPath(String scheme,
                                String repository,
                                String ref,
                                String path)

formatPath

public static String formatPath(String scheme,
                                String repository,
                                String ref)

getScheme

public String getScheme()

setScheme

public void setScheme(String scheme)

clone

public ObjectLocation clone()

Overrides:

clone in class Object

getParent

public ObjectLocation getParent()

getRepository

public String getRepository()

setRepository

public void setRepository(String repository)

getRef

public String getRef()

setRef

public void setRef(String ref)

getPath

public String getPath()

setPath

public void setPath(String path)

isValidPath

public boolean isValidPath()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

onSameBranch

public boolean onSameBranch(ObjectLocation otherObjLoc)

Checks if an ObjectLocation is on the same branch.

Parameters:

otherObjLoc - the objectLocation to compare

Returns:

true if the object location is on same branch, false otherwise

toString

public String toString()

Overrides:

toString in class Object

toRefString

public String toRefString()

toDirectory

public ObjectLocation toDirectory()

toFSPath

public org.apache.hadoop.fs.Path toFSPath()