|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.cone.ConeErrorPolicy
public abstract class ConeErrorPolicy
Defines how errors are treated during a multiple cone search operation. It also makes sure that interruptions are checked for, which is important to stop threads continuing to submit requests to remote services after the client no longer has any need for them.
Field Summary | |
---|---|
static ConeErrorPolicy |
ABORT
An error during a cone search results in a failure of the task. |
static ConeErrorPolicy |
IGNORE
Errors during cone searches are treated as if the search had returned with no results. |
static ConeErrorPolicy |
RETRY
If an error occurs during a cone search it is retried until a non-error result is obtained. |
Constructor Summary | |
---|---|
protected |
ConeErrorPolicy(String name)
Constructor. |
Method Summary | |
---|---|
static ConeErrorPolicy |
createAdviceAbortPolicy(String name,
String extraAdvice)
Returns a policy like ABORT , except that if an error occurs,
the IOException thrown is populated with some custom text. |
static ConeErrorPolicy |
createRetryPolicy(String name,
int nTry)
Constructs an error policy which will retry the search a fixed number of times. |
abstract StarTable |
performConeSearch(ConeSearcher cs,
double ra,
double dec,
double sr)
Uses the given cone searcher object to perform an actual cone search. |
String |
toString()
Returns this object's name. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final ConeErrorPolicy ABORT
public static final ConeErrorPolicy IGNORE
public static final ConeErrorPolicy RETRY
Constructor Detail |
---|
protected ConeErrorPolicy(String name)
name
- policy nameMethod Detail |
---|
public String toString()
toString
in class Object
public abstract StarTable performConeSearch(ConeSearcher cs, double ra, double dec, double sr) throws IOException, InterruptedException
performSearch
method.
Implementations are expected to check for thread interruption status and throw an InterruptedException if interruption has happened. They should do this in such a way that the cone search query is not performed (especially multiple times) following an interruption.
cs
- cone searcher providing basic cone search capabilitiesra
- right ascension in degrees of search region centredec
- declination in degrees of search region centresr
- search radius in degrees
IOException
- if an IO error occurs
InterruptedException
- if the thread was interruptedConeSearcher.performSearch(double, double, double)
public static ConeErrorPolicy createRetryPolicy(String name, int nTry)
name
- policy namenTry
- maximum number of attempts;
if <=0 will retry indefinitely
public static ConeErrorPolicy createAdviceAbortPolicy(String name, String extraAdvice)
ABORT
, except that if an error occurs,
the IOException thrown is populated with some custom text.
name
- policy nameextraAdvice
- advice to user in case of cone search failure
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |