Package org.dspace.app.rest.projection

Class SpecificLevelProjection

java.lang.Object

org.dspace.app.rest.projection.AbstractProjection

org.dspace.app.rest.projection.SpecificLevelProjection

All Implemented Interfaces:

Projection

public class SpecificLevelProjection
extends AbstractProjection

This Projection will allow us to specify how many levels deep we're going to embed resources onto the requested HalResource. The projection is used by using the name combined with the embedLevelDepth parameter to specify how deep the embeds have to go. There is an upperlimit in place for this, which is specified on the bean through the maxEmbed property

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Fields inherited from interface org.dspace.app.rest.projection.Projection

DEFAULT

Constructor Summary

Constructors

Constructor	Description
SpecificLevelProjection()

Method Summary

Modifier and Type	Method	Description
boolean	allowEmbedding(HALResource<? extends RestAddressableModel> halResource, LinkRest linkRest, org.springframework.hateoas.Link... oldLinks)	Tells whether this projection permits the embedding of a particular embeddable subresource.
boolean	allowLinking(HALResource halResource, LinkRest linkRest)	Tells whether this projection permits the linking of a particular linkable subresource.
int	getMaxEmbed()
String	getName()	Gets the projection name.
void	setMaxEmbed(int maxEmbed)

Methods inherited from class org.dspace.app.rest.projection.AbstractProjection

getPagingOptions, transformModel, transformResource, transformRest

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

SpecificLevelProjection

public SpecificLevelProjection()

Method Detail

getMaxEmbed

public int getMaxEmbed()

setMaxEmbed

public void setMaxEmbed(int maxEmbed)

getName

public String getName()

Description copied from interface: Projection

Gets the projection name.

Returns:

the name, which is a unique alphanumeric string.

allowEmbedding

public boolean allowEmbedding(HALResource<? extends RestAddressableModel> halResource,
                              LinkRest linkRest,
                              org.springframework.hateoas.Link... oldLinks)

Description copied from interface: Projection

Tells whether this projection permits the embedding of a particular embeddable subresource. This gives the projection an opportunity to opt in to to certain embeds, by returning true. Note: If this method returns true for a given subresource, it will be automatically linked regardless of what Projection.allowLinking(HALResource, LinkRest) returns.

Specified by:

allowEmbedding in interface Projection

Overrides:

allowEmbedding in class AbstractProjection

Parameters:

halResource - the resource from which the embed may or may not be made.

linkRest - the LinkRest annotation through which the related resource was discovered on the rest object.

oldLinks - The previously traversed links

Returns:

true if allowed, false otherwise.

allowLinking

public boolean allowLinking(HALResource halResource,
                            LinkRest linkRest)

Description copied from interface: Projection

Tells whether this projection permits the linking of a particular linkable subresource. This gives the projection an opportunity to opt in to to certain links, by returning true. Note: If Projection.allowEmbedding(HALResource, LinkRest, Link...) returns true for a given subresource, it will be automatically linked regardless of what this method returns.

Specified by:

allowLinking in interface Projection

Overrides:

allowLinking in class AbstractProjection

Parameters:

halResource - the resource from which the link may or may not be made.

linkRest - the LinkRest annotation through which the related resource was discovered on the rest object.

Returns:

true if allowed, false otherwise.