Result (Java 2 Platform SE 5.0) (original) (raw)

javax.xml.transform

Interface Result

All Known Implementing Classes:

public interface Result

An object that implements this interface contains the information needed to build a transformation result tree.

Field Summary
static String	PI_DISABLE_OUTPUT_ESCAPING The name of the processing instruction that is sent if the result tree disables output escaping.
static String	PI_ENABLE_OUTPUT_ESCAPING The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.

Method Summary
String	getSystemId() Get the system identifier that was set with setSystemId.
void	setSystemId(String systemId) Set the system identifier for this Result.

Field Detail

PI_DISABLE_OUTPUT_ESCAPING

static final String PI_DISABLE_OUTPUT_ESCAPING

The name of the processing instruction that is sent if the result tree disables output escaping.

Normally, result tree serialization escapes & and < (and possibly other characters) when outputting text nodes. This ensures that the output is well-formed XML. However, it is sometimes convenient to be able to produce output that is almost, but not quite well-formed XML; for example, the output may include ill-formed sections that will be transformed into well-formed XML by a subsequent non-XML aware process. If a processing instruction is sent with this name, serialization should be output without any escaping.

Result DOM trees may also have PI_DISABLE_OUTPUT_ESCAPING and PI_ENABLE_OUTPUT_ESCAPING inserted into the tree.

PI_ENABLE_OUTPUT_ESCAPING

static final String PI_ENABLE_OUTPUT_ESCAPING

The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.

Method Detail

setSystemId

void setSystemId(String systemId)

Set the system identifier for this Result.

If the Result is not to be written to a file, the system identifier is optional. The application may still want to provide one, however, for use in error messages and warnings, or to resolve relative output identifiers.

Parameters:

systemId - The system identifier as a URI string.

getSystemId

String getSystemId()

Get the system identifier that was set with setSystemId.

Returns:

The system identifier that was set with setSystemId, or null if setSystemId was not called.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.