org.apache.marmotta.platform.ldp.api

Class Preference

java.lang.Object

org.apache.marmotta.platform.ldp.api.Preference

public class Preference
extends Object

Preferences, which triples to include in a response.

Author:

Jakob Frank

See Also:

http://www.w3.org/TR/ldp/#prefer-parameters

Method Summary

Methods

Modifier and Type	Method and Description
static Preference	defaultPreference() The default preference: not minimal, all included.
boolean	includeContainment() Should containment triples be included in the response?
boolean	includeContent() Should the LDP-RS content be included in the response?
boolean	includeMembership() Should membership triples be included in the response?
boolean	includeMinimalContainer() Should minimal container triples be included in the response?
static Preference	includePreference(String... includes) Non-minimal preference, with only the args included.
boolean	isMinimal() Reflects a Prefer: return="minimal" header
static Preference	minimalPreference() The minimal preference: minimal is true, nothing included.
static Preference	omitPreference(String... omits) Non-minimal preference, with all the provided args omitted.
void	setContainment(boolean containment) Setting containment to true will also set minimal to false
void	setContent(boolean content) Setting content to true will also set minimal to false
void	setMembership(boolean membership) Setting membership to true will also set minimal to false
void	setMinimal(boolean minimal) If minimal is set to true, all other settings will be set to false.
void	setMinimalContainer(boolean minimalContainer) Setting minimal container to true will also set minimal to false

Methods inherited from class java.lang.Object

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

Method Detail

isMinimal

public boolean isMinimal()

Reflects a Prefer: return="minimal" header

Returns:

true if the minimal representation is preferred by the client

includeContent

public boolean includeContent()

Should the LDP-RS content be included in the response?

Returns:

true if the content triples should be included in the response

includeMembership

public boolean includeMembership()

Should membership triples be included in the response?

Returns:

true if membership triples should be included in the response

See Also:

http://www.w3.org/TR/ldp/#dfn-membership-triples

includeContainment

public boolean includeContainment()

Should containment triples be included in the response?

Returns:

true if containment triples should be included in the response

See Also:

http://www.w3.org/TR/ldp/#dfn-containment-triples

includeMinimalContainer

public boolean includeMinimalContainer()

Should minimal container triples be included in the response?

Returns:

true if minimal container triples should be included in the response

See Also:

http://www.w3.org/TR/ldp/#dfn-minimal-container-triples

setMinimal

public void setMinimal(boolean minimal)

If minimal is set to true, all other settings will be set to false.

Parameters:

minimal - whether minimal representation is preferred.

setContent

public void setContent(boolean content)

Setting content to true will also set minimal to false

Parameters:

content - should the LDP-RS content be included in the response?

setMembership

public void setMembership(boolean membership)

Setting membership to true will also set minimal to false

Parameters:

membership - should membership triples be included in the response?

See Also:

http://www.w3.org/TR/ldp/#dfn-membership-triples

setContainment

public void setContainment(boolean containment)

Setting containment to true will also set minimal to false

Parameters:

containment - should containment triples be included in the response?

See Also:

http://www.w3.org/TR/ldp/#dfn-containment-triples

setMinimalContainer

public void setMinimalContainer(boolean minimalContainer)

Setting minimal container to true will also set minimal to false

Parameters:

minimalContainer - should minimal container triples be included in the response?

See Also:

http://www.w3.org/TR/ldp/#dfn-minimal-container-triples

defaultPreference

public static Preference defaultPreference()

The default preference: not minimal, all included.

Returns:

the default preference.

minimalPreference

public static Preference minimalPreference()

The minimal preference: minimal is true, nothing included.

Returns:

the minimal preference.

includePreference

public static Preference includePreference(String... includes)

Non-minimal preference, with only the args included.

Parameters:

includes - LDP-Preference URIs to include in the response

Returns:

a non-minimal preference, with only the provided parts included.

See Also:

http://www.w3.org/TR/ldp/#h5_prefer-uris

omitPreference

public static Preference omitPreference(String... omits)

Non-minimal preference, with all the provided args omitted.

Parameters:

omits - LDP-Preference URIs to omit in the response

Returns:

a non-minimal preference, with all provided parts excluded.

See Also:

http://www.w3.org/TR/ldp/#h5_prefer-uris