org.apache.nutch.parse
Class ParseStatus

java.lang.Object
  org.apache.hadoop.io.VersionedWritable
      org.apache.nutch.parse.ParseStatus

All Implemented Interfaces:

Writable

public class ParseStatus
extends VersionedWritable

Author:

Andrzej Bialecki <ab@getopt.org>

Field Summary

static byte	FAILED General failure.
static short	FAILED_EXCEPTION Parsing failed.
static short	FAILED_INVALID_FORMAT Parsing failed.
static short	FAILED_MISSING_CONTENT Parsing failed.
static short	FAILED_MISSING_PARTS Parsing failed.
static short	FAILED_TRUNCATED Parsing failed.
static String[]	majorCodes
static byte	NOTPARSED Parsing was not performed.
static ParseStatus	STATUS_FAILURE
static ParseStatus	STATUS_NOTPARSED
static ParseStatus	STATUS_SUCCESS
static byte	SUCCESS Parsing succeeded.
static short	SUCCESS_REDIRECT Parsed content contains a directive to redirect to another URL.

Constructor Summary

ParseStatus()

ParseStatus(int majorCode)

ParseStatus(int majorCode, int minorCode)

ParseStatus(int majorCode, int minorCode, String message)
Simplified constructor for passing just a text message.

ParseStatus(int majorCode, int minorCode, String[] args)

ParseStatus(int majorCode, String message)
Simplified constructor for passing just a text message.

ParseStatus(int majorCode, String[] args)

ParseStatus(Throwable t)

Method Summary

boolean	equals(Object o)
String[]	getArgs()
Parse	getEmptyParse(Configuration conf) A convenience method.
int	getMajorCode()
String	getMessage() A convenience method.
int	getMinorCode()
byte	getVersion() Return the version number of the current implementation.
int	hashCode()
boolean	isSuccess() A convenience method.
static ParseStatus	read(DataInput in)
void	readFields(DataInput in) Reads the fields of this object from in.
void	setArgs(String[] args)
void	setMajorCode(byte majorCode)
void	setMessage(String msg)
void	setMinorCode(short minorCode)
String	toString()
void	write(DataOutput out) Writes the fields of this object to out.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NOTPARSED

public static final byte NOTPARSED

Parsing was not performed.

See Also:

Constant Field Values

SUCCESS

public static final byte SUCCESS

Parsing succeeded.

See Also:

Constant Field Values

FAILED

public static final byte FAILED

General failure. There may be a more specific error message in arguments.

See Also:

Constant Field Values

majorCodes

public static final String[] majorCodes

SUCCESS_REDIRECT

public static final short SUCCESS_REDIRECT

Parsed content contains a directive to redirect to another URL. The target URL can be retrieved from the arguments.

See Also:

Constant Field Values

FAILED_EXCEPTION

public static final short FAILED_EXCEPTION

Parsing failed. An Exception occured (which may be retrieved from the arguments).

See Also:

Constant Field Values

FAILED_TRUNCATED

public static final short FAILED_TRUNCATED

Parsing failed. Content was truncated, but the parser cannot handle incomplete content.

See Also:

Constant Field Values

FAILED_INVALID_FORMAT

public static final short FAILED_INVALID_FORMAT

Parsing failed. Invalid format - the content may be corrupted or of wrong type.

See Also:

Constant Field Values

FAILED_MISSING_PARTS

public static final short FAILED_MISSING_PARTS

Parsing failed. Other related parts of the content are needed to complete parsing. The list of URLs to missing parts may be provided in arguments. The Fetcher may decide to fetch these parts at once, then put them into Content.metadata, and supply them for re-parsing.

See Also:

Constant Field Values

FAILED_MISSING_CONTENT

public static final short FAILED_MISSING_CONTENT

Parsing failed. There was no content to be parsed - probably caused by errors at protocol stage.

See Also:

Constant Field Values

STATUS_NOTPARSED

public static final ParseStatus STATUS_NOTPARSED

STATUS_SUCCESS

public static final ParseStatus STATUS_SUCCESS

STATUS_FAILURE

public static final ParseStatus STATUS_FAILURE

Constructor Detail

ParseStatus

public ParseStatus()

ParseStatus

public ParseStatus(int majorCode,
                   int minorCode,
                   String[] args)

ParseStatus

public ParseStatus(int majorCode)

ParseStatus

public ParseStatus(int majorCode,
                   String[] args)

ParseStatus

public ParseStatus(int majorCode,
                   int minorCode)

ParseStatus

public ParseStatus(int majorCode,
                   int minorCode,
                   String message)

Simplified constructor for passing just a text message.

ParseStatus

public ParseStatus(int majorCode,
                   String message)

Simplified constructor for passing just a text message.

ParseStatus

public ParseStatus(Throwable t)

Method Detail

getVersion

public byte getVersion()

Description copied from class: VersionedWritable

Return the version number of the current implementation.

Specified by:

getVersion in class VersionedWritable

read

public static ParseStatus read(DataInput in)
                        throws IOException

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Description copied from interface: Writable

Reads the fields of this object from in. For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Overrides:

readFields in class VersionedWritable

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Description copied from interface: Writable

Writes the fields of this object to out.

Specified by:

write in interface Writable

Overrides:

write in class VersionedWritable

Throws:

IOException

isSuccess

public boolean isSuccess()

A convenience method. Returns true if majorCode is SUCCESS, false otherwise.

getMessage

public String getMessage()

A convenience method. Return a String representation of the first argument, or null.

getArgs

public String[] getArgs()

getMajorCode

public int getMajorCode()

getMinorCode

public int getMinorCode()

getEmptyParse

public Parse getEmptyParse(Configuration conf)

A convenience method. Creates an empty Parse instance, which returns this status.

toString

public String toString()

Overrides:

toString in class Object

setArgs

public void setArgs(String[] args)

setMessage

public void setMessage(String msg)

setMajorCode

public void setMajorCode(byte majorCode)

setMinorCode

public void setMinorCode(short minorCode)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object