Package com.day.cq.dam.commons.util

Class SchemaFormHelper

java.lang.Object

com.day.cq.dam.commons.util.SchemaFormHelper

public class SchemaFormHelper
extends Object

this is an internal class to be used by dam code.

Constructor Summary

Constructors

Constructor	Description
SchemaFormHelper()

Method Summary

Modifier and Type	Method	Description
static String[]	getBaseFormPaths(ResourceResolver resourceResolver)
static List<Resource>	getMasterForms(Resource currentForm)	Deprecated. Use getPrimaryForms(Resource resource) instead
static List<Resource>	getMasterForms(Resource currentForm, String formsBaseDirPath)	Deprecated. Use getMasterForms(Resource resource) instead
static List<Resource>	getPrimaryForms(Resource currentForm)	Given current form, returns a list of primary.
static Iterator	getSchemaFormsIterator(ResourceResolver resolver, String suffix, int rows, int offset)
static Iterator	getSchemaFormsIterator(SlingHttpServletRequest request, int rows, int offset)
static Resource	getSchemaResource(SlingHttpServletRequest request)
static Resource	mergeFormTabResource(Resource oneTabList, Resource otherTabList)	Merge two list of tabs i.e.

Methods inherited from class java.lang.Object

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

Constructor Details

SchemaFormHelper

public SchemaFormHelper()

Method Details

getMasterForms

@Deprecated
public static List<Resource> getMasterForms(Resource currentForm,
 String formsBaseDirPath)
                                     throws RepositoryException

Deprecated.

Use getMasterForms(Resource resource) instead

Given current form, returns a list of master. Looks for master forms up in the path heirarchy, while traversing it takes into account any override available in apps

Parameters:

currentForm - current form resource

Returns:

list of master form resource, empty list if no master is found

Throws:

RepositoryException

getBaseFormPaths

public static String[] getBaseFormPaths(ResourceResolver resourceResolver)

Returns:

Metadata Schema provides a OOTB form. And User can overlay this form as per use case. It returns list of form path homes (Overlay, OOTB) in the order. e.g. [/conf/metdataschema, /libs/metadataschema]

getMasterForms

public static List<Resource> getMasterForms(Resource currentForm)
                                     throws RepositoryException

Deprecated.

Use getPrimaryForms(Resource resource) instead

Given current form, returns a list of master. Looks for master forms up in the path heirarchy, while traversing it takes into account any override available in apps

Parameters:

currentForm - current form resource

Returns:

list of master form resource, empty list if no master is found

Throws:

RepositoryException

NullPointerException

getPrimaryForms

public static List<Resource> getPrimaryForms(Resource currentForm)
                                      throws RepositoryException

Given current form, returns a list of primary. Looks for primary forms up in the path heirarchy, while traversing it takes into account any override available in apps

Parameters:

currentForm - current form resource

Returns:

list of primary form resource, empty list if no primary is found

Throws:

RepositoryException

NullPointerException

mergeFormTabResource

public static Resource mergeFormTabResource(Resource oneTabList,
 Resource otherTabList)

Merge two list of tabs i.e. form/items/tabs

Parameters:

oneTabList - resource representing one tab list

otherTabList - resource representing other tab list

Returns:

merged tab list resource

getSchemaResource

public static Resource getSchemaResource(SlingHttpServletRequest request)

getSchemaFormsIterator

public static Iterator getSchemaFormsIterator(SlingHttpServletRequest request,
 int rows,
 int offset)

getSchemaFormsIterator

public static Iterator getSchemaFormsIterator(ResourceResolver resolver,
 String suffix,
 int rows,
 int offset)