info.magnolia.ui.vaadin.integration.contentconnector

Class JcrContentConnector

java.lang.Object

info.magnolia.ui.vaadin.integration.contentconnector.AbstractContentConnector

info.magnolia.ui.vaadin.integration.contentconnector.JcrContentConnector

All Implemented Interfaces:

ContentConnector, SupportsCreation, SupportsVersions

public class JcrContentConnector
extends AbstractContentConnector
implements SupportsVersions, SupportsCreation

JCR-based implementation of ContentConnector.

Constructor Summary

Constructors

Constructor and Description
JcrContentConnector(info.magnolia.cms.core.version.VersionManager versionManager, JcrContentConnectorDefinition definition, info.magnolia.objectfactory.ComponentProvider componentProvider)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandleItem(Object itemId) Check whether current ContentConnector is capable of fetching a Vaadin Item with a specific id.
JcrContentConnectorDefinition	getContentConnectorDefinition()
Object	getDefaultItemId() Get the default item id which for instance could be used as a view selection if no actual item is selected.
JcrItemAdapter	getItem(Object itemId) Fetch Vaadin Item by its id.
Object	getItemId(com.vaadin.data.Item item) Get item id.
JcrItemId	getItemIdByUrlFragment(String urlFragment) Fetch item id from its string representation.
String	getItemUrlFragment(Object itemId) Convert an item id (arbitrary object) to its string representation which can be appended to a URL fragment and later be used to fetch the item id back.
Object	getItemVersion(Object itemId, String versionName) Get an item id of an item version.
Object	getNewItemId(Object parentId, Object typeDefinition) Create and return an id of a new item based on the string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JcrContentConnector

@Inject
public JcrContentConnector(info.magnolia.cms.core.version.VersionManager versionManager,
                          JcrContentConnectorDefinition definition,
                          info.magnolia.objectfactory.ComponentProvider componentProvider)

Method Detail

getItemUrlFragment

public String getItemUrlFragment(Object itemId)

Description copied from interface: ContentConnector

Convert an item id (arbitrary object) to its string representation which can be appended to a URL fragment and later be used to fetch the item id back.

Specified by:

getItemUrlFragment in interface ContentConnector

Parameters:

itemId - id of an item to be converted to a string representation.

Returns:

string representation of an item id.

See Also:

ContentConnector.getItemIdByUrlFragment(java.lang.String).

getItemIdByUrlFragment

public JcrItemId getItemIdByUrlFragment(String urlFragment)

Description copied from interface: ContentConnector

Fetch item id from its string representation. Used primarily for restoring selection in views from URL fragments.

Specified by:

getItemIdByUrlFragment in interface ContentConnector

Parameters:

urlFragment - URL fragment that points to an item.

Returns:

item id that corresponds to the URL fragment.

getItem

public JcrItemAdapter getItem(Object itemId)

Description copied from interface: ContentConnector

Fetch Vaadin Item by its id. Such item is not bound to any container and can eventually be used in actions for editing.

Specified by:

getItem in interface ContentConnector

Parameters:

itemId - item id.

Returns:

Vaadin Item that corresponds to the id.

getItemId

public Object getItemId(com.vaadin.data.Item item)

Description copied from interface: ContentConnector

Get item id.

Specified by:

getItemId in interface ContentConnector

Parameters:

item - Item id of which is to be returned.

Returns:

id of an item.

getDefaultItemId

public Object getDefaultItemId()

Description copied from interface: ContentConnector

Get the default item id which for instance could be used as a view selection if no actual item is selected. Most common example of such an item is a root node of the tree hierarchy.

Specified by:

getDefaultItemId in interface ContentConnector

Returns:

default item id.

canHandleItem

public boolean canHandleItem(Object itemId)

Description copied from interface: ContentConnector

Check whether current ContentConnector is capable of fetching a Vaadin Item with a specific id.

Specified by:

canHandleItem in interface ContentConnector

Parameters:

itemId - id of a Vaadin Item to look up.

Returns:

true if such a Vaadin Item exists, false - otherwise.

getItemVersion

public Object getItemVersion(Object itemId,
                    String versionName)

Description copied from interface: SupportsVersions

Get an item id of an item version.

Specified by:

getItemVersion in interface SupportsVersions

Parameters:

itemId - source item id.

versionName - version id.

Returns:

id of version item.

getNewItemId

public Object getNewItemId(Object parentId,
                  Object typeDefinition)

Description copied from interface: SupportsCreation

Create and return an id of a new item based on the string representation.

Specified by:

getNewItemId in interface SupportsCreation

Parameters:

parentId - string representation of a new item.

typeDefinition - definition object which specifies the type of the newly created item.

Returns:

id of a new item.

getContentConnectorDefinition

public JcrContentConnectorDefinition getContentConnectorDefinition()

Overrides:

getContentConnectorDefinition in class AbstractContentConnector