Class ParseStatus

[TOC]

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

org.apache.nutch.parse

java.lang.Object
- org.apache.nutch.parse.ParseStatus

- All Implemented Interfaces:
- org.apache.hadoop.io.Writable

public class ParseStatus
extends Object
implements org.apache.hadoop.io.Writable

Author:
Andrzej Bialecki ab@getopt.org

/ab@getopt.org

Field Summary

Fields Modifier and Type Field and Description 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

Constructors Constructor and Description 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

Methods Modifier and Type Method and Description boolean equals(Object o) String[] getArgs() Parse getEmptyParse(org.apache.hadoop.conf.Configuration conf) A convenience method. ParseResult getEmptyParseResult(String url, org.apache.hadoop.conf.Configuration conf) A convenience method. int getMajorCode() String getMessage() A convenience method. int getMinorCode() byte getVersion() boolean isSuccess() A convenience method. static ParseStatus read(DataInput in) void readFields(DataInput in) void setArgs(String[] args) void setMajorCode(byte majorCode) void setMessage(String msg) void setMinorCode(short minorCode) String toString() void write(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

NOTPARSED

public static final byte NOTPARSED

Parsing was not performed.

  - See Also:
  - [Constant Field Values](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.NOTPARSED)       
-

SUCCESS

public static final byte SUCCESS

Parsing succeeded.

  - See Also:
  - [Constant Field Values](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.SUCCESS)       
-

FAILED

public static final byte FAILED

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

  - See Also:
  - [Constant Field Values](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.FAILED)       
-

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](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.SUCCESS_REDIRECT)       
-

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](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.FAILED_EXCEPTION)       
-

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](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.FAILED_TRUNCATED)       
-

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](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.FAILED_INVALID_FORMAT)       
-

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](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.FAILED_MISSING_PARTS)       
-

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](../../../../constant-values.html#org.apache.nutch.parse.ParseStatus.FAILED_MISSING_CONTENT)       
-

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()

read

public static ParseStatus read(DataInput in)
                        throws IOException

  - Throws: 
  - <code>IOException</code>       
-

readFields

public void readFields(DataInput in)
                throws IOException

  - Specified by: 
  - <code>readFields</code> in interface <code>org.apache.hadoop.io.Writable</code> 
  - Throws: 
  - <code>IOException</code>       
-

write

public void write(DataOutput out)
           throws IOException

  - Specified by: 
  - <code>write</code> in interface <code>org.apache.hadoop.io.Writable</code> 
  - Throws: 
  - <code>IOException</code>       
-

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(org.apache.hadoop.conf.Configuration conf)

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

getEmptyParseResult

public ParseResult getEmptyParseResult(String url,
                              org.apache.hadoop.conf.Configuration conf)

A convenience method. Creates an empty ParseResult, which contains this status.

toString

public String toString()

  - Overrides: 
  - <code>toString</code> in class <code>Object</code>        
-

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: 
  - <code>equals</code> in class <code>Object</code>

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method