Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-07-24 17:32:48 +00:00 · 2005-12-08 07:13:07 +00:00
commit e1e6508fec
1095 changed files with 230566 additions and 0 deletions
--- a/source/java/org/alfresco/repo/search/Indexer.java
+++ b/source/java/org/alfresco/repo/search/Indexer.java
@@ -0,0 +1,105 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.repo.search;
+
+import org.alfresco.service.cmr.repository.ChildAssociationRef;
+import org.alfresco.service.cmr.repository.NodeRef;
+
+/**
+ * This interface abstracts how indexing is used from within the node service
+ * implementation.
+ * 
+ * It has to optionally offer transactional integration For example, the lucene
+ * indexer
+ * 
+ * @author andyh
+ */
+
+public interface Indexer
+{
+    /**
+     * Create an index entry when a new node is created. A node is always
+     * created with a name in a given parent and so a relationship ref is
+     * required.
+     * 
+     * @param relationshipRef
+     */
+    public void createNode(ChildAssociationRef relationshipRef);
+
+    /**
+     * Update an index entry due to property changes on a node. There are no
+     * strucural impications from such a change.
+     * 
+     * @param nodeRef
+     */
+    public void updateNode(NodeRef nodeRef);
+
+    /**
+     * Delete a node entry from an index. This implies structural change. The
+     * node will be deleted from the index. This will also remove any remaining
+     * refernces to the node from the index. The index has no idea of the
+     * primary link.
+     * 
+     * @param relationshipRef
+     */
+    public void deleteNode(ChildAssociationRef relationshipRef);
+
+    /**
+     * Create a refernce link between a parent and child. Implies only
+     * (potential) structural changes
+     * 
+     * @param relationshipRef
+     */
+    public void createChildRelationship(ChildAssociationRef relationshipRef);
+
+    /**
+     * Alter the relationship between parent and child nodes in the index.
+     * 
+     * This can be used for:
+     * <OL>
+     * <LI> rename,
+     * <LI> move,
+     * <LI> move and rename,
+     * <LI> replace
+     * </OL>
+     * 
+     * This could be implemented as a delete and add but some implementations
+     * may be able to optimise this operation.
+     * 
+     * @param relationshipBeforeRef
+     * @param relationshipAfterRef
+     */
+    public void updateChildRelationship(ChildAssociationRef relationshipBeforeRef, ChildAssociationRef relationshipAfterRef);
+
+    /**
+     * Delete a relationship between a parent and child.
+     * 
+     * This will remove a structural route through the index. The index has no
+     * idea of reference and primary relationships and will happily remove the
+     * primary relationship before refernces which could remain.
+     * 
+     * Use delete to ensure all strctural references are removed or call this
+     * sure you are doing an unlink (remove a hard link in the unix file system
+     * world).
+     * 
+     * @param relationshipRef
+     */
+    public void deleteChildRelationship(ChildAssociationRef relationshipRef);
+    
+    
+
+}