Package org.craftercms.studio.api.v2.dal

Interface DependencyDAO

public interface DependencyDAO

Author:

Dejan Brkic

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SOURCE_PATH_COLUMN_NAME
static final String	TARGET_PATH_COLUMN_NAME

Method Summary

Modifier and Type	Method	Description
List<Dependency>	getDependenciesByType(String siteId, String sourcePath, String dependencyType)	Get dependencies for content path by type
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, long modifiedMask, long newMask)	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, long modifiedMask, long newMask)	Get soft dependencies from DB for list of content paths

Field Details

SOURCE_PATH_COLUMN_NAME

static final String SOURCE_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 Details

getSoftDependenciesForList

List<Map<String,String>> getSoftDependenciesForList(@Param("site")
 String site,
 @Param("paths")
 Set<String> paths,
 @Param("regex")
 List<String> itemSpecificDependenciesPatterns,
 @Param("modifiedMask")
 long modifiedMask,
 @Param("newMask")
 long newMask)

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

modifiedMask - state bit mask for modified item

newMask - state bit mask for new item

Returns:

List of soft dependencies

getHardDependenciesForList

List<Map<String,String>> getHardDependenciesForList(@Param("site")
 String site,
 @Param("paths")
 Set<String> paths,
 @Param("regex")
 List<String> itemSpecificDependenciesPatterns,
 @Param("modifiedMask")
 long modifiedMask,
 @Param("newMask")
 long newMask)

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

modifiedMask - state bit map for modified item

newMask - state bit map for new item

Returns:

List of hard dependencies

getDependentItems

List<String> getDependentItems(@Param("siteId")
 String siteId,
 @Param("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("siteId")
 String siteId,
 @Param("paths")
 List<String> paths,
 @Param("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

getDependenciesByType

List<Dependency> getDependenciesByType(@Param("siteId")
 String siteId,
 @Param("sourcePath")
 String sourcePath,
 @Param("type")
 String dependencyType)

Get dependencies for content path by type

Parameters:

siteId - site identifier

sourcePath - content path

dependencyType - dependency type

Returns:

list of dependencies