Package org.hippoecm.frontend.editor.workflow.model

Class AbstractReferencesDataProvider

java.lang.Object

org.hippoecm.frontend.model.NodeModelWrapper<Node>

org.hippoecm.frontend.editor.workflow.model.AbstractReferencesDataProvider

All Implemented Interfaces:

Serializable, org.apache.wicket.markup.repeater.data.IDataProvider<DocumentReference>, org.apache.wicket.model.IDetachable, org.apache.wicket.model.IModel<Node>, org.apache.wicket.util.io.IClusterable, ISelectableDataProvider<DocumentReference>

Direct Known Subclasses:

AbstractNodeReferenceDataProvider, SiteReferencesDataProvider

public abstract class AbstractReferencesDataProvider
extends NodeModelWrapper<Node>
implements ISelectableDataProvider<DocumentReference>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractReferencesDataProvider.ReferenceType

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DocumentReference>	data
protected int	numberOfResults
protected final AbstractReferencesDataProvider.ReferenceType	referenceType
protected final List<org.apache.wicket.model.IModel<DocumentReference>>	selectedItems

Fields inherited from class org.hippoecm.frontend.model.NodeModelWrapper

nodeModel

Constructor Summary

Constructors

Constructor	Description
AbstractReferencesDataProvider(JcrNodeModel nodeModel, AbstractReferencesDataProvider.ReferenceType referenceType, String locale)

Method Summary

Modifier and Type	Method	Description
protected ReferenceDetail	getComponentReferenceDetail(ComponentReference reference)	Returns the first matching ReferenceDetail for the given ComponentReference.
protected ReferenceDetail	getDocumentReferenceDetail(DocumentReference documentReference)
int	getLimit()	Returns the maximum number of items that can be returned.
int	getNumberOfResults()	Returns the estimate of the total number of results.
abstract ReferenceDetail	getReferenceDetail(DocumentReference documentReference)	Returns the ReferenceDetail for the given DocumentReference.
abstract List<DocumentReference>	getReferences(Node handle)	Returns the list of DocumentReferences for the given handle.
AbstractReferencesDataProvider.ReferenceType	getReferenceType()
List<org.apache.wicket.model.IModel<DocumentReference>>	getSelectedItems()	Returns the selected items.
protected List<DocumentReference>	getUnifiedSiteReferences(Node handle)
Iterator<DocumentReference>	iterator(long first, long count)
org.apache.wicket.model.IModel<DocumentReference>	model(DocumentReference reference)
long	size()

Methods inherited from class org.hippoecm.frontend.model.NodeModelWrapper

detach, getNode, getNodeModel, getObject, setNodeModel, setObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.markup.repeater.data.IDataProvider

detach

Methods inherited from interface org.apache.wicket.model.IModel

as, combineWith, filter, flatMap, isPresent, map, orElse, orElseGet

Field Details

referenceType

protected final AbstractReferencesDataProvider.ReferenceType referenceType

selectedItems

protected final transient List<org.apache.wicket.model.IModel<DocumentReference>> selectedItems

numberOfResults

protected transient int numberOfResults

data

protected transient List<DocumentReference> data

Constructor Details

AbstractReferencesDataProvider

public AbstractReferencesDataProvider(JcrNodeModel nodeModel,
 AbstractReferencesDataProvider.ReferenceType referenceType,
 String locale)

Method Details

iterator

public Iterator<DocumentReference> iterator(long first,
 long count)

Specified by:

iterator in interface org.apache.wicket.markup.repeater.data.IDataProvider<DocumentReference>

getNumberOfResults

public int getNumberOfResults()

Description copied from interface: ISelectableDataProvider

Returns the estimate of the total number of results. When this number is unknown or equal to the hard limit of 1000, then -1 is returned.

Specified by:

getNumberOfResults in interface ISelectableDataProvider<DocumentReference>

getLimit

public int getLimit()

Description copied from interface: ISelectableDataProvider

Returns the maximum number of items that can be returned.

Specified by:

getLimit in interface ISelectableDataProvider<DocumentReference>

size

public long size()

Specified by:

size in interface org.apache.wicket.markup.repeater.data.IDataProvider<DocumentReference>

model

public org.apache.wicket.model.IModel<DocumentReference> model(DocumentReference reference)

Specified by:

model in interface org.apache.wicket.markup.repeater.data.IDataProvider<DocumentReference>

getSelectedItems

public List<org.apache.wicket.model.IModel<DocumentReference>> getSelectedItems()

Description copied from interface: ISelectableDataProvider

Returns the selected items.

Specified by:

getSelectedItems in interface ISelectableDataProvider<DocumentReference>

getReferenceType

public AbstractReferencesDataProvider.ReferenceType getReferenceType()

getUnifiedSiteReferences

protected List<DocumentReference> getUnifiedSiteReferences(Node handle)
                                                    throws RepositoryException

Throws:

RepositoryException

getDocumentReferenceDetail

protected ReferenceDetail getDocumentReferenceDetail(DocumentReference documentReference)

getComponentReferenceDetail

protected ReferenceDetail getComponentReferenceDetail(ComponentReference reference)

Returns the first matching ReferenceDetail for the given ComponentReference.

Parameters:

reference - the component reference that is either a xpage or a hst component

Returns:

reference detail

getReferences

public abstract List<DocumentReference> getReferences(Node handle)
                                               throws RepositoryException

Returns the list of DocumentReferences for the given handle.

Parameters:

handle - the document handle

Returns:

list of document references

Throws:

RepositoryException

getReferenceDetail

public abstract ReferenceDetail getReferenceDetail(DocumentReference documentReference)

Returns the ReferenceDetail for the given DocumentReference.

Parameters:

documentReference - the reference

Returns:

reference detail