Package com.github.rcaller.rstuff

Class RCallerOptions

java.lang.Object

com.github.rcaller.rstuff.RCallerOptions

public class RCallerOptions
extends Object

Method Summary

Modifier and Type	Method	Description
static RCallerOptions	create()
static RCallerOptions	create(FailurePolicy failurePolicy, long maxWaitTime)
static RCallerOptions	create(FailurePolicy failurePolicy, long maxWaitTime, long initialWaitTime, RProcessStartUpOptions rProcessStartUpOptions)
static RCallerOptions	create(FailurePolicy failurePolicy, long maxWaitTime, RProcessStartUpOptions rProcessStartUpOptions)
static RCallerOptions	create(RProcessStartUpOptions rProcessStartUpOptions)
static RCallerOptions	create(String rScriptExecutable, String rExecutable, FailurePolicy failurePolicy, long maxWaitTime, long initialWaitTime, RProcessStartUpOptions rProcessStartUpOptions)
static RCallerOptions	create(String rScriptExecutable, String rExecutable, FailurePolicy failurePolicy, long maxWaitTime, long initialWaitTime, RProcessStartUpOptions rProcessStartUpOptions, boolean useArrowIfAvailable, boolean failIfArrowNotAvailable)
boolean	failIfArrowNotAvailable()	Whether we should not use XML as backward behavior iif useArrowIfAvailable is true but Arrow is not available
FailurePolicy	getFailurePolicy()
long	getInitialWaitTime()
long	getMaxWaitTime()	How long this R caller will wait for the R process to terminate before forcibly killing it
int	getRetries()
String	getrExecutable()
RProcessStartUpOptions	getrProcessStartUpOptions()
String	getrScriptExecutable()
String	getStartUpOptionsAsCommand()
void	incrementRetries()
void	resetRetries()
void	setFailIfArrowNotAvailable(boolean failIfArrowNotAvailable)
void	setFailurePolicy(FailurePolicy failurePolicy)
void	setInitialWaitTime(long initialWaitTime)
void	setMaxWaitTime(long maxWaitTime)
void	setRetries(int retries)
void	setrExecutable(String rExecutable)
void	setrProcessStartUpOptions(RProcessStartUpOptions rProcessStartUpOptions)
void	setrScriptExecutable(String rScriptExecutable)
void	setUseArrowIfAvailable(boolean useArrowIfAvailable)
boolean	useArrowIfAvailable()	Whether we should try to use Apache Arrow for transferring output data

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RCallerOptions create()

Returns:

a default RCallerOptions object

create

public static RCallerOptions create(RProcessStartUpOptions rProcessStartUpOptions)

create

public static RCallerOptions create(FailurePolicy failurePolicy,
                                    long maxWaitTime)

create

public static RCallerOptions create(FailurePolicy failurePolicy,
                                    long maxWaitTime,
                                    RProcessStartUpOptions rProcessStartUpOptions)

create

public static RCallerOptions create(FailurePolicy failurePolicy,
                                    long maxWaitTime,
                                    long initialWaitTime,
                                    RProcessStartUpOptions rProcessStartUpOptions)

create

public static RCallerOptions create(String rScriptExecutable,
                                    String rExecutable,
                                    FailurePolicy failurePolicy,
                                    long maxWaitTime,
                                    long initialWaitTime,
                                    RProcessStartUpOptions rProcessStartUpOptions)

create

public static RCallerOptions create(String rScriptExecutable,
                                    String rExecutable,
                                    FailurePolicy failurePolicy,
                                    long maxWaitTime,
                                    long initialWaitTime,
                                    RProcessStartUpOptions rProcessStartUpOptions,
                                    boolean useArrowIfAvailable,
                                    boolean failIfArrowNotAvailable)

getrScriptExecutable

public String getrScriptExecutable()

getrExecutable

public String getrExecutable()

getFailurePolicy

public FailurePolicy getFailurePolicy()

getMaxWaitTime

public long getMaxWaitTime()

How long this R caller will wait for the R process to terminate before forcibly killing it

Returns:

maxWaitTime - the max time to wait

getInitialWaitTime

public long getInitialWaitTime()

getrProcessStartUpOptions

public RProcessStartUpOptions getrProcessStartUpOptions()

getRetries

public int getRetries()

getStartUpOptionsAsCommand

public String getStartUpOptionsAsCommand()

incrementRetries

public void incrementRetries()

resetRetries

public void resetRetries()

useArrowIfAvailable

public boolean useArrowIfAvailable()

Whether we should try to use Apache Arrow for transferring output data

failIfArrowNotAvailable

public boolean failIfArrowNotAvailable()

Whether we should not use XML as backward behavior iif useArrowIfAvailable is true but Arrow is not available

setrScriptExecutable

public void setrScriptExecutable(String rScriptExecutable)

setrExecutable

public void setrExecutable(String rExecutable)

setFailurePolicy

public void setFailurePolicy(FailurePolicy failurePolicy)

setMaxWaitTime

public void setMaxWaitTime(long maxWaitTime)

setInitialWaitTime

public void setInitialWaitTime(long initialWaitTime)

setrProcessStartUpOptions

public void setrProcessStartUpOptions(RProcessStartUpOptions rProcessStartUpOptions)

setRetries

public void setRetries(int retries)

setUseArrowIfAvailable

public void setUseArrowIfAvailable(boolean useArrowIfAvailable)

setFailIfArrowNotAvailable

public void setFailIfArrowNotAvailable(boolean failIfArrowNotAvailable)