Package com.stardog.stark.query.io

Class QueryResultWriters

java.lang.Object

com.stardog.stark.query.io.QueryResultWriters

public final class QueryResultWriters
extends java.lang.Object

Utilities for writing query results.

Since:

1.0

Version:

1.0

Author:

Michael Grove

Method Summary

Modifier and Type	Method	Description
static java.util.Optional<BooleanQueryResultWriter>	to(QueryResultFormat theFormat, java.io.OutputStream theOutputStream, Options theOptions)
static java.util.Optional<QueryResultWriter>	to(java.io.OutputStream theOutput, QueryResultFormat theFormat)	Create a new writer to write in the specified format with the default options.
static java.util.Optional<QueryResultWriter>	to(java.io.OutputStream theOutput, QueryResultFormat theFormat, Options theOptions)	Create a new writer to write in the specified format with the default options.
static void	write(BooleanQueryResult theResult, java.io.OutputStream theOutput, QueryResultFormat theQueryResultFormat)
static void	write(BooleanQueryResult theResult, java.nio.file.Path thePath, QueryResultFormat theQueryResultFormat)
static void	write(QueryResult theResult, java.nio.file.Path thePath, QueryResultFormat theQueryResultFormat)
static void	write(SelectQueryResult theResult, SelectQueryResultWriter theWriter)
static void	write(SelectQueryResult theResult, java.io.OutputStream theOutput, QueryResultFormat theQueryResultFormat)
static void	write(SelectQueryResult theResult, java.nio.file.Path thePath, QueryResultFormat theQueryResultFormat)

Methods inherited from class java.lang.Object

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

Method Detail

write

public static void write(@Nonnull
                         QueryResult theResult,
                         @Nonnull
                         java.nio.file.Path thePath,
                         @Nonnull
                         QueryResultFormat theQueryResultFormat)
                  throws java.io.IOException,
                         ResultWritingFailed

Throws:

java.io.IOException

ResultWritingFailed

Implementation Notes:

The result set is closed as a side effect of this call

write

public static void write(@Nonnull
                         BooleanQueryResult theResult,
                         @Nonnull
                         java.nio.file.Path thePath,
                         @Nonnull
                         QueryResultFormat theQueryResultFormat)
                  throws java.io.IOException,
                         ResultWritingFailed

Throws:

java.io.IOException

ResultWritingFailed

Implementation Notes:

The result set is closed as a side effect of this call

write

public static void write(@Nonnull
                         BooleanQueryResult theResult,
                         @Nonnull
                         java.io.OutputStream theOutput,
                         @Nonnull
                         QueryResultFormat theQueryResultFormat)
                  throws java.io.IOException,
                         ResultWritingFailed

Throws:

java.io.IOException

ResultWritingFailed

Implementation Notes:

The result set is closed as a side effect of this call

write

public static void write(@Nonnull
                         SelectQueryResult theResult,
                         @Nonnull
                         java.nio.file.Path thePath,
                         @Nonnull
                         QueryResultFormat theQueryResultFormat)
                  throws java.io.IOException,
                         ResultWritingFailed

Throws:

java.io.IOException

ResultWritingFailed

Implementation Notes:

The result set is closed as a side effect of this call

write

public static void write(@Nonnull
                         SelectQueryResult theResult,
                         @Nonnull
                         java.io.OutputStream theOutput,
                         @Nonnull
                         QueryResultFormat theQueryResultFormat)
                  throws java.io.IOException,
                         ResultWritingFailed

Throws:

java.io.IOException

ResultWritingFailed

Implementation Notes:

The result set is closed as a side effect of this call

write

public static void write(@Nonnull
                         SelectQueryResult theResult,
                         @Nonnull
                         SelectQueryResultWriter theWriter)
                  throws ResultWritingFailed

Throws:

ResultWritingFailed

Implementation Notes:

The result set is closed as a side effect of this call

to

public static java.util.Optional<QueryResultWriter> to(@Nonnull
                                                       java.io.OutputStream theOutput,
                                                       @Nonnull
                                                       QueryResultFormat theFormat)

Create a new writer to write in the specified format with the default options.

Parameters:

theOutput - the output to write to

theFormat - the format to write in

Returns:

the `QueryResultWriter` to use for writing

See Also:

QueryResultWriterOptions

Implementation Notes:

The `OutputStream` is *not* closed when writing is complete

to

public static java.util.Optional<BooleanQueryResultWriter> to(@Nonnull
                                                              QueryResultFormat theFormat,
                                                              @Nonnull
                                                              java.io.OutputStream theOutputStream,
                                                              @Nonnull
                                                              Options theOptions)

to

public static java.util.Optional<QueryResultWriter> to(@Nonnull
                                                       java.io.OutputStream theOutput,
                                                       @Nonnull
                                                       QueryResultFormat theFormat,
                                                       @Nonnull
                                                       Options theOptions)

Create a new writer to write in the specified format with the default options.

Parameters:

theOutput - the output to write to

theFormat - the format to write in

Returns:

the `QueryResultWriter` to use for writing

See Also:

QueryResultWriterOptions

Implementation Notes:

The `OutputStream` is *not* closed when writing is complete