com.marklogic.client.document

Interface DocumentUriTemplate

All Superinterfaces:

ContentDescriptor

public interface DocumentUriTemplate
extends ContentDescriptor

A DocumentUriTemplate specifies how the server should construct a name for a document.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Method Summary

Modifier and Type	Method and Description
String	getDirectory() Returns the directory that should prefix the document uri.
String	getExtension() Returns the extension that should suffix the document uri.
void	setDirectory(String directory) Specifies the directory that should prefix the document uri.
void	setExtension(String extension) Specifies the extension that should suffix the document uri.
DocumentUriTemplate	withDirectory(String directory) Specifies the directory that should prefix the document uri and returns the template object.
DocumentUriTemplate	withFormat(Format format) Specifies the format of the document and returns the template object.

Methods inherited from interface com.marklogic.client.document.ContentDescriptor

getByteLength, getFormat, getMimetype, setByteLength, setFormat, setMimetype

Method Detail

getDirectory

String getDirectory()

Returns the directory that should prefix the document uri.

Returns:

the directory.

setDirectory

void setDirectory(String directory)

Specifies the directory that should prefix the document uri.

Parameters:

directory - the directory.

withDirectory

DocumentUriTemplate withDirectory(String directory)

Specifies the directory that should prefix the document uri and returns the template object.

Parameters:

directory - the directory.

Returns:

the template object.

getExtension

String getExtension()

Returns the extension that should suffix the document uri.

Returns:

the extension.

setExtension

void setExtension(String extension)

Specifies the extension that should suffix the document uri. The extension should not start with the period separator.

Parameters:

extension - the extension.

withFormat

DocumentUriTemplate withFormat(Format format)

Specifies the format of the document and returns the template object.

Parameters:

format - the format.

Returns:

the template object.