ModelManagement.java

package com.bagri.core.server.api;

import java.util.Collection;
import java.util.Set;

import com.bagri.core.api.BagriException;
import com.bagri.core.model.NodeKind;
import com.bagri.core.model.Occurrence;
import com.bagri.core.model.Path;

/**
 * XDM document management interface; provided for the client side
 * manages schema meta-data in internal caches;
 * performs translations for namespace, path, document types
 * 
 * @author Denis Sukhoroslov
 */
public interface ModelManagement {
	
	/**
	 * translates full node path like "/{http://tpox-benchmark.com/security}Security/{http://tpox-benchmark.com/security}Name/text()"
	 * to XDMPath;
	 * 
	 * creates new XDMPath if it is not registered yet;
	 * 
	 * @param root String; the corresponding document's root
	 * @param path String; the full node path in Clark form
	 * @param kind XDMNodeKind; the type of the node, one of {@link NodeKind} enum literals
	 * @param parentId int; id of the parent path
	 * @param dataType int; type of the node value
	 * @param occurrence {@link Occurrence}; multiplicity of the node
	 * @return new or existing {@link Path} structure
	 * @throws BagriException in case of any error
	 */
	Path translatePath(String root, String path, NodeKind kind, int parentId, int dataType, Occurrence occurrence) throws BagriException;
	
	/**
	 * translates regex expression like "^/ns0:Security/ns0:SecurityInformation/.(*)/ns0:Sector/text\\(\\)$";
	 * to an array of registered pathIds which conforms to the regex specified
	 * 
	 * @param root String; the corresponding document's root
	 * @param regex String; regex pattern 
	 * @return Set<Integer>- set of registered pathIds conforming to the pattern provided
	 */
	Set<Integer> translatePathFromRegex(String root, String regex);
	
	/**
	 * translates regex expression like "^/ns0:Security/ns0:SecurityInformation/.(*)/ns0:Sector/text\\(\\)$";
	 * to Collection of registered path which conforms to the regex specified
	 * 
	 * @param root String; the corresponding document's root
	 * @param regex String; regex pattern 
	 * @return Set<String>- set of registered paths conforming to the pattern provided
	 */
	Collection<String> getPathFromRegex(String root, String regex);
	
	/**
	 * return array of pathIds which are children of the root specified;
	 * 
	 * @param root String; the corresponding document's root
	 * @param root String; root node path 
	 * @return Set<Integer>- set of registered pathIds who are direct or indirect children of the parent path provided
	 */
	Set<Integer> getPathElements(String root);
	
	/**
	 * search for registered full node path like "/{http://tpox-benchmark.com/security}Security/{http://tpox-benchmark.com/security}Name/text()"
	 * 
	 * @param root String; node root in Clark form
	 * @param path String; node path in Clark form
	 * @return registered {@link Path} structure if any
	 */
	Path getPath(String root, String path); 

	/**
	 * return XDM path instance by pathId provided;
	 * 
	 * @param pathId int; the id of registered node path
	 * @return registered {@link Path} structure for the id provided
	 */
	Path getPath(int pathId);
	
	/**
	 * return collection of paths registered for the document type provided;
	 * 
	 * @param root String; the corresponding document's root
	 * @return Collection of {@link Path} belonging to the typeId provided; result is sorted by pathId
	 */
	Collection<Path> getTypePaths(String root);
	
	/**
	 * 
	 * @param path the long element path
	 * @return the path root
	 */
	String getPathRoot(String path);
	
	/**
	 * updates the Path in cache
	 * 
	 * @param path the Path to update
	 */
	void updatePath(Path path);

}