Versions Compared

Old Version 3

changes.mady.by.user Maciej Rudowicz

Saved on

compared with

New Version Current

changes.mady.by.user Maciej Majchrzak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section describes key classes which are essential while using Slice. They constitute a base for a day-to-day development.

...

The com.cognifide.slice.api.provider.ModelProvider interface is a basic base interface of in Slice. It allows you to fetch an injectable object(s) mapped from specified resource or path. It's very similar to Guice com.google.inject.Injector because it is used for fetching objects of different classes. However it's more Sling-related because it always takes resource (or path) as a parameter, so that an object of the specified class can be mapped. You should use ModelProvider whenever there is a need for injecting a model mapped from a given resource (path).

...

MethodDescription
<T> T get(final Class<T> type, final String path);

Creates an object of class type and maps it from a resource from under specified path

<T> T get(final Class<T> type, final Resource resource);Creates an object of class type and maps it from the resource
<T> T get(com.google.inject.Key<T> key, Resource resource) String path) throws ClassNotFoundException;
Creates an object identified by key type and maps it from the resource under specified path
<T> T get(com.google.inject.Key<T> key, String pathResource resource) throws ClassNotFoundException; Creates an object identified by key type and maps it from the resource under specified path
<T> List<T> getChildModels(Class<T> type, Resource parentResourceString parentPath) ;
Creates a list of objects of class type and maps it from the resources under specified parent path
<T> List<T> getChildModels(Class<T> type, String parentPathResource parentResource); Creates a list of objects of class type and maps it from the resources under specified parent resource
Object get(final String className, final String path) throws ClassNotFoundException;Creates an object of a class defined by specified className String and maps it from a resource from under specified path
Object get(String className, Resource resource) throws ClassNotFoundException; Creates an object of a class defined by specified className String and maps it from the resource
<T> List<T> getList(final Class<T> type, final Iterator<String> paths);Creates a list of objects of class type and maps them accordingly from resources from under paths defined by paths interator iterator.
<T> List<T> getList(final Class<T> type, final String[] paths);

Creates a list of objects of class type and maps them accordingly from resources from under paths defined by paths array.

<T> List<T> getListFromResources(Class<T> type, Iterator<Resource> resources); Creates a list of objects of class type and maps it from corresponding resources returned by iterator

ModelProvider can be injected to your models, so that you can read a model from an arbitrary resource or path, e.g.:

Code Block
import com.cognifide.app.util.Currency;

import com.cognifide.slice.api.provider.ModelProvider;
import com.cognifide.slice.mapper.annotation.JcrProperty;
import com.cognifide.slice.mapper.annotation.SliceResource;
import com.google.inject.Inject;

@SliceResource
public class OrderModel {

    private final static String CONFIGURATION_PATH = "/content/app/configuration/jcr:content/currency";

    private final ModelProvider modelProvider;

    @JcrProperty
    private int value;

    @Inject
    public OrderModel(ModelProvider modelProvider) {
        this.modelProvider = modelProvider;
    }

    public int getValue() {
        Currency currency = modelProvider.get(Currency.class, CONFIGURATION_PATH);
        return formatToCurrency(value, currency);
    }
    ...
}

ChildrenProvider

...

 Anchor
Deprecated
Deprecated
@Deprecated API
Few API members have been deprecated in Slice 4.0 and should be avoided where possible.
DeprecatedSuggestion
com.cognifide.slice.api.provider.ChildrenProvider
...
Below table describes methods of the interface.
MethodDescription
List<String> getChildren(final String path);Returns paths to child resources of a resource from under specified path. If a resource under specified path doesn't exist, empty list is returned. The method is not recursive - it reads only direct children.
List<Resource> getChildResources(final String path);Returns child resources of a resource from under specified path. If a resource under specified path doesn't exist, empty list is returned. The method is not recursive - it reads only direct children
Link, LinkBuilder
...

Use one of ModelProvider's methods:
  • <T> List<T> getChildModels(Class<T> type, String parentPath);
  • <T> List<T> getChildModels(Class<T> type, Resource parentResource);
  • <T> List<T> getList(Class<T> type, String[] paths);
  • <T> List<T> getList(Class<T> type, Iterator<String> paths);
com.cognifide.slice.api.
...
They should be used whenever there is a need to modify an existing link (e.g. adding or removing some selectors) or create a new one and then manipulate it.
New link can only be created using LinkBuilder. LinkBuilder can be obtained from LinkBuilderFactory which is injectable. An example usage of it is shown in the listings below:
 Code Block
import com.cognifide.slice.api.link.Link;
import com.cognifide.slice.api.link.LinkBuilder;
import com.cognifide.slice.api.link.LinkBuilderFactory;
import com.cognifide.slice.api.qualifier.CurrentResourcePath;
import com.google.inject.Inject;

public class EventModel {
    private final LinkBuilderFactory linkBuilderFactory;
    private final String currentPath;
    
    @Inject
    public EventModel(LinkBuilderFactory linkBuilderFactory, @CurrentResourcePath String currentPath) {
        this.linkBuilderFactory = linkBuilderFactory;
        this.currentPath = currentPath;
    }

    public Link getPrintLink() {
        LinkBuilder linkBuilder = linkBuilderFactory.getLinkBuilder();
        linkBuilder.setPath(currentPath);
        linkBuilder.setSelectorString("print");
        linkBuilder.setExtension("pdf");
        return linkBuilder.toLink();
    }
    ...
}
...
provider.ModelProvider
  • getChildren(String path)
  • getChildResources(String path)
Use Resource.listChildren()
com.cognifide.slice.api.link.
...
 Info
titleBest practice
There is no need to create Link objects if you're not going to modify any aspects of link. If you only want to display a link you can build it simply using String concatenation.
ClassToKeyMapper
...
*
Whole package (link API) has been removed in Slice 4.0.0
If your code is dependent on it, feel free to extract code from Slice 3.2.0 source code: https://github.com/Cognifide/Slice/tree/3.2.0
ClassToKeyMapper
The com.cognifide.slice.api.provider.ClassToKeyMapper interface allows you to obtain a com.google.inject.Key associated with a class specified by a String value. Thanks to this you can inject objects of classes specified by Strings rather than classes. In general, this interface is not widely used. is no longer part of the Slice API - it has been moved to com.cognifide.slice.core.internal.provider.ClassToKeyMapper