org.ldp4j.application.ext.annotations

Annotation Type IndirectContainer

@Documented
@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface IndirectContainer

Used for defining templates for Indirect Container LDP Resources.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id The identifier of the template.
Class<? extends ResourceHandler>	memberHandler The ResourceHandler class that will handle the member resources of the container.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Attachment[]	attachments The attachments of the template.
String	description A description of the purpose of the template.
String	insertedContentRelation The predicate that should be used for specifying the indirect identifier (URIRef) of a member of the container
String	memberPath If defined, the path prefix to be used when publishing member resources.
String	membershipPredicate The membership predicate to use for relating the member resources with the container.
MembershipRelation	membershipRelation The membership relation to use for defining direction of the relationship between the member resources with the container.
String	name The human-based name of the template.

Element Detail

id

public abstract String id

The identifier of the template. The identifier must be application-unique.

Returns:

the identifier of the template.

memberHandler

public abstract Class<? extends ResourceHandler> memberHandler

The ResourceHandler class that will handle the member resources of the container.

Returns:

the class that will handle the members of the container.

name

public abstract String name

The human-based name of the template.

Returns:

the name of the template.

Default:

""

description

public abstract String description

A description of the purpose of the template.

Returns:

the description of the template

Default:

""

attachments

public abstract Attachment[] attachments

The attachments of the template.

Returns:

the attachments of the template

Default:

{}

memberPath

public abstract String memberPath

If defined, the path prefix to be used when publishing member resources.

Returns:

the path prefix used for publishing member resources

Default:

""

membershipPredicate

public abstract String membershipPredicate

The membership predicate to use for relating the member resources with the container.

Returns:

the membership predicate used for relating container members

Default:

"http://www.w3.org/ns/ldp#member"

membershipRelation

public abstract MembershipRelation membershipRelation

The membership relation to use for defining direction of the relationship between the member resources with the container.

Returns:

the membership relation used for defining direction of the relationship between the member resources with the container.

Default:

org.ldp4j.application.ext.annotations.MembershipRelation.HAS_MEMBER

insertedContentRelation

public abstract String insertedContentRelation

The predicate that should be used for specifying the indirect identifier (URIRef) of a member of the container

Returns:

the predicate used for specifying the indirect identifier of a member of the container

Default:

"http://www.w3.org/ns/ldp#MemberSubject"