AbstractLinkingRenderer (Grace Framework

grails.rest.render.util.AbstractLinkingRenderer

@CompileStatic
abstract class AbstractLinkingRenderer<T>
extends AbstractIncludeExcludeRenderer<T>

Abstract base class for HAL renderers

Authors:: Graeme Rocher

Since:: 2.3

Field Summary

Fields
Modifiers	Name	Description
`protected static List<String>`	`DEFAULT_EXCLUDES`
`static String`	`DEPRECATED_ATTRIBUTE`
`static String`	`HREFLANG_ATTRIBUTE`
`static String`	`HREF_ATTRIBUTE`
`static String`	`RELATIONSHIP_SELF`
`static String`	`TEMPLATED_ATTRIBUTE`
`static String`	`TITLE_ATTRIBUTE`
`static String`	`TYPE_ATTRIBUTE`

Properties Summary

Properties
Type	Name and description
`boolean`	`absoluteLinks`
`String`	`encoding`
`GrailsConventionGroovyPageLocator`	`groovyPageLocator`
`LinkGenerator`	`linkGenerator`
`MappingContext`	`mappingContext`
`MessageSource`	`messageSource`
`boolean`	`prettyPrint`
`ProxyHandler`	`proxyHandler`
`RendererRegistry`	`rendererRegistry`

Constructor Summary

Constructors
Constructor and description
`AbstractLinkingRenderer(Class<T> targetType, MimeType mimeType)`
`AbstractLinkingRenderer(Class<T> targetType, MimeType[] mimeTypes)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected String`	`getLinkTitle(PersistentEntity entity, Locale locale)`
	`Collection<Link>`	`getLinksForObject(Object object)`
	`protected String`	`getResourceTitle(String uri, Locale locale)`
	`protected boolean`	`isDomainResource(Class clazz)`
	`void`	`render(T object, RenderContext context)`
	`abstract void`	`renderInternal(T object, RenderContext context)`
	`protected Map<Association, Object>`	`writeAssociationLinks(RenderContext context, Object object, Locale locale, Object writer, PersistentEntity entity, MetaClass metaClass)`
	`protected void`	`writeDomain(RenderContext context, MetaClass metaClass, PersistentEntity entity, Object object, Object writer)` Writes a domain instance
	`protected abstract void`	`writeDomainProperty(Object value, String propertyName, Object writer)`
	`protected void`	`writeExtraLinks(Object object, Locale locale, Object writer)`
	`protected abstract void`	`writeLink(Link link, Locale locale, Object writerObject)`

- Field Detail
  - protected static final List<String> DEFAULT_EXCLUDES
  - public static final String DEPRECATED_ATTRIBUTE
  - public static final String HREFLANG_ATTRIBUTE
  - public static final String HREF_ATTRIBUTE
  - public static final String RELATIONSHIP_SELF
  - public static final String TEMPLATED_ATTRIBUTE
  - public static final String TITLE_ATTRIBUTE
  - public static final String TYPE_ATTRIBUTE
- Property Detail
  - boolean absoluteLinks
  - String encoding
  - @Autowired(required: false)
    GrailsConventionGroovyPageLocator groovyPageLocator
  - @Autowired
    LinkGenerator linkGenerator
  - @Autowired
    @Qualifier(value: grailsDomainClassMappingContext)
    MappingContext mappingContext
  - @Autowired
    MessageSource messageSource
  - boolean prettyPrint
  - @Autowired(required: false)
    ProxyHandler proxyHandler
  - @Autowired
    RendererRegistry rendererRegistry
- Constructor Detail
  - AbstractLinkingRenderer(Class<T> targetType, MimeType mimeType)
  - AbstractLinkingRenderer(Class<T> targetType, MimeType[] mimeTypes)
- Method Detail
  - protected String getLinkTitle(PersistentEntity entity, Locale locale)
  - @CompileStatic(value: TypeCheckingMode.SKIP)
    Collection<Link> getLinksForObject(Object object)
  - protected String getResourceTitle(String uri, Locale locale)
  - protected boolean isDomainResource(Class clazz)
  - @Override
    void render(T object, RenderContext context)
  - abstract void renderInternal(T object, RenderContext context)
  - protected Map<Association, Object> writeAssociationLinks(RenderContext context, Object object, Locale locale, Object writer, PersistentEntity entity, MetaClass metaClass)
  - protected void writeDomain(RenderContext context, MetaClass metaClass, PersistentEntity entity, Object object, Object writer)
    
    Writes a domain instance
    Parameters:
    clazz - The class
    object - The object
    writer - The writer
    Returns:
    Any associations embedded within the object
  - protected abstract void writeDomainProperty(Object value, String propertyName, Object writer)
  - protected void writeExtraLinks(Object object, Locale locale, Object writer)
  - protected abstract void writeLink(Link link, Locale locale, Object writerObject)

Summary:
Field
Property
Constructor
Method

[Groovy] Class AbstractLinkingRenderer<T>

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Field Detail

protected static final List<String> DEFAULT_EXCLUDES

public static final String DEPRECATED_ATTRIBUTE

public static final String HREFLANG_ATTRIBUTE

public static final String HREF_ATTRIBUTE

public static final String RELATIONSHIP_SELF

public static final String TEMPLATED_ATTRIBUTE

public static final String TITLE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

Property Detail

boolean absoluteLinks

String encoding

@Autowired(required: false)
GrailsConventionGroovyPageLocator groovyPageLocator

@Autowired
LinkGenerator linkGenerator

@Autowired
@Qualifier(value: grailsDomainClassMappingContext)
MappingContext mappingContext

@Autowired
MessageSource messageSource

boolean prettyPrint

@Autowired(required: false)
ProxyHandler proxyHandler

@Autowired
RendererRegistry rendererRegistry

Constructor Detail

AbstractLinkingRenderer(Class<T> targetType, MimeType mimeType)

AbstractLinkingRenderer(Class<T> targetType, MimeType[] mimeTypes)

Method Detail

protected String getLinkTitle(PersistentEntity entity, Locale locale)

@CompileStatic(value: TypeCheckingMode.SKIP)
Collection<Link> getLinksForObject(Object object)

protected String getResourceTitle(String uri, Locale locale)

protected boolean isDomainResource(Class clazz)

@Override
void render(T object, RenderContext context)

abstract void renderInternal(T object, RenderContext context)

protected Map<Association, Object> writeAssociationLinks(RenderContext context, Object object, Locale locale, Object writer, PersistentEntity entity, MetaClass metaClass)

protected void writeDomain(RenderContext context, MetaClass metaClass, PersistentEntity entity, Object object, Object writer)

protected abstract void writeDomainProperty(Object value, String propertyName, Object writer)

protected void writeExtraLinks(Object object, Locale locale, Object writer)

protected abstract void writeLink(Link link, Locale locale, Object writerObject)

[Groovy] Class AbstractLinkingRenderer<T>

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Field Detail

protected static final List<String> DEFAULT_EXCLUDES

public static final String DEPRECATED_ATTRIBUTE

public static final String HREFLANG_ATTRIBUTE

public static final String HREF_ATTRIBUTE

public static final String RELATIONSHIP_SELF

public static final String TEMPLATED_ATTRIBUTE

public static final String TITLE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

Property Detail

boolean absoluteLinks

String encoding

@Autowired(required: false)GrailsConventionGroovyPageLocator groovyPageLocator

@AutowiredLinkGenerator linkGenerator

@Autowired@Qualifier(value: grailsDomainClassMappingContext)MappingContext mappingContext

@AutowiredMessageSource messageSource

boolean prettyPrint

@Autowired(required: false)ProxyHandler proxyHandler

@AutowiredRendererRegistry rendererRegistry

Constructor Detail

AbstractLinkingRenderer(Class<T> targetType, MimeType mimeType)

AbstractLinkingRenderer(Class<T> targetType, MimeType[] mimeTypes)

Method Detail

protected String getLinkTitle(PersistentEntity entity, Locale locale)

@CompileStatic(value: TypeCheckingMode.SKIP)Collection<Link> getLinksForObject(Object object)

protected String getResourceTitle(String uri, Locale locale)

protected boolean isDomainResource(Class clazz)

@Overridevoid render(T object, RenderContext context)

abstract void renderInternal(T object, RenderContext context)

protected Map<Association, Object> writeAssociationLinks(RenderContext context, Object object, Locale locale, Object writer, PersistentEntity entity, MetaClass metaClass)

protected void writeDomain(RenderContext context, MetaClass metaClass, PersistentEntity entity, Object object, Object writer)

protected abstract void writeDomainProperty(Object value, String propertyName, Object writer)

protected void writeExtraLinks(Object object, Locale locale, Object writer)

protected abstract void writeLink(Link link, Locale locale, Object writerObject)

@Autowired(required: false)
GrailsConventionGroovyPageLocator groovyPageLocator

@Autowired
LinkGenerator linkGenerator

@Autowired
@Qualifier(value: grailsDomainClassMappingContext)
MappingContext mappingContext

@Autowired
MessageSource messageSource

@Autowired(required: false)
ProxyHandler proxyHandler

@Autowired
RendererRegistry rendererRegistry

@CompileStatic(value: TypeCheckingMode.SKIP)
Collection<Link> getLinksForObject(Object object)

@Override
void render(T object, RenderContext context)