org.springframework.data.rest.webmvc.support

Class PersistentEntityProjector

java.lang.Object

org.springframework.data.rest.webmvc.support.PersistentEntityProjector

All Implemented Interfaces:

Projector

public class PersistentEntityProjector
extends Object
implements Projector

Projector looking up a projection by name for the given source type.

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
PersistentEntityProjector(ProjectionDefinitions projectionDefinitions, ProjectionFactory factory, String projection, ResourceMappings mappings) Creates a new PersistentEntityProjector using the given ProjectionDefinitions, ProjectionFactory and projection name.

Method Summary

Modifier and Type	Method and Description
boolean	hasExcerptProjection(Class<?> type) Returns whether an excerpt projection has been registered for the given type.
Object	project(Object source) Returns the projection object for the given source.
Object	projectExcerpt(Object source) Creates a excerpt projection for the given source.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistentEntityProjector

public PersistentEntityProjector(ProjectionDefinitions projectionDefinitions,
                                 ProjectionFactory factory,
                                 String projection,
                                 ResourceMappings mappings)

Creates a new PersistentEntityProjector using the given ProjectionDefinitions, ProjectionFactory and projection name.

Parameters:

projectionDefinitions - must not be null.

factory - must not be null.

projection - can be empty.

Method Detail

project

public Object project(Object source)

Description copied from interface: Projector

Returns the projection object for the given source. This may result in the same object being returned or a completely different acting as projection for the source.

Specified by:

project in interface Projector

Parameters:

source - must not be null.

Returns:

projectExcerpt

public Object projectExcerpt(Object source)

Description copied from interface: Projector

Creates a excerpt projection for the given source. If no excerpt projection is available, the call will fall back to the behavior of Projector.project(Object). If you completely wish to skip handling the object, check for the presence of an excerpt projection using Projector.hasExcerptProjection(Class).

Specified by:

projectExcerpt in interface Projector

Parameters:

source - must not be null.

Returns:

hasExcerptProjection

public boolean hasExcerptProjection(Class<?> type)

Description copied from interface: Projector

Returns whether an excerpt projection has been registered for the given type.

Specified by:

hasExcerptProjection in interface Projector

Parameters:

type - must not be null.

Returns: