org.craftercms.studio.api.v2.dal

Interface DependencyDAO

public interface DependencyDAO

Author:

Dejan Brkic

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDITED_STATES_PARAM
static String	NEW_PATH_PARAM
static String	NEW_STATES_PARAM
static String	OLD_PATH_PARAM
static String	PATH_PARAM
static String	PATHS_PARAM
static String	REGEX_PARAM
static String	SITE_ID_PARAM
static String	SITE_PARAM
static String	SORUCE_PATH_COLUMN_NAME
static String	TARGET_PATH_COLUMN_NAME

Method Summary

Modifier and Type	Method and Description
List<String>	getDependentItems(String siteId, List<String> paths) Get items depending on given paths
List<Map<String,String>>	getHardDependenciesForList(String site, Set<String> paths, List<String> itemSpecificDependenciesPatterns, Collection<State> editedStates, List<State> newStates) Get hard dependencies from DB for list of content paths
List<String>	getItemSpecificDependencies(String siteId, List<String> paths, List<String> regex) Get item specific dependencies for given paths
List<Map<String,String>>	getSoftDependenciesForList(String site, Set<String> paths, List<String> itemSpecificDependenciesPatterns, Collection<State> editedStates) Get soft dependencies from DB for list of content paths

Field Detail

SITE_PARAM

static final String SITE_PARAM

See Also:

Constant Field Values

SITE_ID_PARAM

static final String SITE_ID_PARAM

See Also:

Constant Field Values

PATH_PARAM

static final String PATH_PARAM

See Also:

Constant Field Values

PATHS_PARAM

static final String PATHS_PARAM

See Also:

Constant Field Values

OLD_PATH_PARAM

static final String OLD_PATH_PARAM

See Also:

Constant Field Values

NEW_PATH_PARAM

static final String NEW_PATH_PARAM

See Also:

Constant Field Values

REGEX_PARAM

static final String REGEX_PARAM

See Also:

Constant Field Values

EDITED_STATES_PARAM

static final String EDITED_STATES_PARAM

See Also:

Constant Field Values

NEW_STATES_PARAM

static final String NEW_STATES_PARAM

See Also:

Constant Field Values

SORUCE_PATH_COLUMN_NAME

static final String SORUCE_PATH_COLUMN_NAME

See Also:

Constant Field Values

TARGET_PATH_COLUMN_NAME

static final String TARGET_PATH_COLUMN_NAME

See Also:

Constant Field Values

Method Detail

getSoftDependenciesForList

List<Map<String,String>> getSoftDependenciesForList(@Param(value="site")
                                                    String site,
                                                    @Param(value="paths")
                                                    Set<String> paths,
                                                    @Param(value="regex")
                                                    List<String> itemSpecificDependenciesPatterns,
                                                    @Param(value="editedStates")
                                                    Collection<State> editedStates)

Get soft dependencies from DB for list of content paths

Parameters:

site - site identifier

paths - list of content paths

itemSpecificDependenciesPatterns - list of patterns that define item specific dependencies

editedStates - list of edited states

Returns:

List of soft dependencies

getHardDependenciesForList

List<Map<String,String>> getHardDependenciesForList(@Param(value="site")
                                                    String site,
                                                    @Param(value="paths")
                                                    Set<String> paths,
                                                    @Param(value="regex")
                                                    List<String> itemSpecificDependenciesPatterns,
                                                    @Param(value="editedStates")
                                                    Collection<State> editedStates,
                                                    @Param(value="newStates")
                                                    List<State> newStates)

Get hard dependencies from DB for list of content paths

Parameters:

site - site identifier

paths - list of content paths

itemSpecificDependenciesPatterns - list of patterns that define item specific dependencies

editedStates - list of edited states

newStates - list of new states

Returns:

List of hard dependencies

getDependentItems

List<String> getDependentItems(@Param(value="siteId")
                               String siteId,
                               @Param(value="paths")
                               List<String> paths)

Get items depending on given paths

Parameters:

siteId - site identifier

paths - list of content paths

Returns:

List of items depending on given paths

getItemSpecificDependencies

List<String> getItemSpecificDependencies(@Param(value="siteId")
                                         String siteId,
                                         @Param(value="paths")
                                         List<String> paths,
                                         @Param(value="regex")
                                         List<String> regex)

Get item specific dependencies for given paths

Parameters:

siteId - site identifier

paths - list of content paths

regex - list of patterns that define item specific dependencies

Returns:

list of item specific dependencies