Package io.github.malteseduck.springframework.data.marklogic.core.mapping

Annotation Type Document

@Inherited
@Retention(RUNTIME)
@Target(TYPE)
public @interface Document

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
DocumentFormat	format	The serialization format to use for documents of the annotated type.
Class<? extends ServerTransformer>	transformer	The configured transformer class to use for the entity for server read/write transforms.
String	type	The name to use for the type of document which will be persisted into the database.
TypePersistenceStrategy	typeStrategy	Set to scope queries to a "type" as defined by the configured strategy.
String	uri	The base URI for documents of the annotated type.
String	value	Alias for uri().

Element Detail

value

String value

Alias for uri().

Intended to be used when no other attributes are needed, for example: @Document("/articles").

See Also:

uri()

Default:

""

uri

String uri

The base URI for documents of the annotated type. If the type persistence strategy is set to "URI" then will scope all queries to limit to only documents under this URI. Defaults to "/TYPE_NAME/".

Default:

""

format

DocumentFormat format

The serialization format to use for documents of the annotated type.

Default:

io.github.malteseduck.springframework.data.marklogic.core.mapping.DocumentFormat.JSON

type

String type

The name to use for the type of document which will be persisted into the database. This overrides the default of using the class simple name (or full class name, depending on configuration).

Default:

""

typeStrategy

TypePersistenceStrategy typeStrategy

Set to scope queries to a "type" as defined by the configured strategy.

Default:

io.github.malteseduck.springframework.data.marklogic.core.mapping.TypePersistenceStrategy.COLLECTION

transformer

Class<? extends ServerTransformer> transformer

The configured transformer class to use for the entity for server read/write transforms. An implementation of the ServerTransform interface.

Default:

io.github.malteseduck.springframework.data.marklogic.core.convert.ServerTransformer.class