org.daisy.pipeline.client.models

Class Result

java.lang.Object

org.daisy.pipeline.client.models.Result

All Implemented Interfaces:

Comparable<Result>

public class Result
extends Object
implements Comparable<Result>

Field Summary

Fields

Modifier and Type	Field and Description
String	file
String	filename
String	from
String	href
String	mimeType
String	name
String	nicename
String	prettyRelativeHref
String	relativeHref
Long	size

Constructor Summary

Constructors

Constructor and Description
Result()

Method Summary

Modifier and Type	Method and Description
File	asFile() Get the result as a File object if possible; null otherwise.
String	asText() Get the result as a String object if possible; null otherwise.
Document	asXml() Get the result as a Document object if possible; null otherwise.
int	compareTo(Result other)
static Result	parseResultXml(Node resultNode)
static Result	parseResultXml(Node resultNode, String base)
void	toXml(Element resultElement)

Methods inherited from class java.lang.Object

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

Field Detail

href

public String href

file

public String file

mimeType

public String mimeType

name

public String name

from

public String from

nicename

public String nicename

size

public Long size

filename

public String filename

prettyRelativeHref

public String prettyRelativeHref

relativeHref

public String relativeHref

Constructor Detail

Result

public Result()

Method Detail

parseResultXml

public static Result parseResultXml(Node resultNode)
                             throws Pipeline2Exception

Throws:

Pipeline2Exception

parseResultXml

public static Result parseResultXml(Node resultNode,
                                    String base)
                             throws Pipeline2Exception

Throws:

Pipeline2Exception

compareTo

public int compareTo(Result other)

Specified by:

compareTo in interface Comparable<Result>

toXml

public void toXml(Element resultElement)

asFile

public File asFile()

Get the result as a File object if possible; null otherwise.

Returns:

The file

asText

public String asText()

Get the result as a String object if possible; null otherwise.

Returns:

The text in the file

asXml

public Document asXml()

Get the result as a Document object if possible; null otherwise.

Returns:

The XML in the file