You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by ed...@apache.org on 2003/07/03 13:44:37 UTC

cvs commit: cocoon-lenya/src/java/org/apache/lenya/cms/ant ComputeRenameDocumentId.java ComputeNewDocumentId.java ComputeCopyDocumentId.java

edith       2003/07/03 04:44:37

  Modified:    src/java/org/apache/lenya/cms/ant ComputeCopyDocumentId.java
  Added:       src/java/org/apache/lenya/cms/ant
                        ComputeRenameDocumentId.java
                        ComputeNewDocumentId.java
  Log:
  ant task to compute the different document ids of the destination in case of copy, move and rename
  
  Revision  Changes    Path
  1.3       +24 -95    cocoon-lenya/src/java/org/apache/lenya/cms/ant/ComputeCopyDocumentId.java
  
  Index: ComputeCopyDocumentId.java
  ===================================================================
  RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/cms/ant/ComputeCopyDocumentId.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- ComputeCopyDocumentId.java	30 Jun 2003 11:42:51 -0000	1.2
  +++ ComputeCopyDocumentId.java	3 Jul 2003 11:44:37 -0000	1.3
  @@ -55,25 +55,18 @@
   */
   package org.apache.lenya.cms.ant;
   
  -import org.apache.lenya.cms.publication.UniqueDocumentId;
  -
  -import org.apache.tools.ant.BuildException;
  -import org.apache.tools.ant.Project;
  -import org.apache.tools.ant.Target;
  -import org.apache.tools.ant.Task;
  -
  +import java.io.File;
   import java.util.StringTokenizer;
   
   
   /**
  - * Compute the unique document id for the copy from the document id
  - * of the copied file and this of the parent document of the copy.
  + * Sets the property "newdocumentid" in the project to the value of the computed 
  + * unique document id (document id of the parent + last token of the id of 
  + * the source)
  + * Used by Copy and Move
    * @author edith
    */
  -public class ComputeCopyDocumentId extends Task {
  -    private String absolutetreepath;
  -    private String firstdocumentid;
  -    private String secdocumentid;
  +public class ComputeCopyDocumentId extends ComputeNewDocumentId {
   
       /**
        * Creates a new instance of ComputeCopyDocumentId
  @@ -83,87 +76,23 @@
       }
   
       /**
  -     * @return absolutetreepath The absolute path of the tree
  -     */
  -    protected String getAbsolutetreepath() {
  -        return absolutetreepath;
  -    }
  -
  -    /**
  -     * set the value of the absolute path of the tree
  -     * @param string The absolute path of the tree
  -     */
  -    public void setAbsolutetreepath(String string) {
  -        absolutetreepath = string;
  -    }
  -
  -    /**
  -     * @return string The document id of the file to copy
  -     */
  -    protected String getFirstdocumentid() {
  -        return firstdocumentid;
  -    }
  -
  -    /**
  -     * set the value of the document id of the file to copy
  -     * @param string The document id of the file to copy
  -     */
  -    public void setFirstdocumentid(String string) {
  -        firstdocumentid = string;
  -    }
  -
  -    /**
  -     * @return documentId The document id of the parent of the copy file.
  -     */
  -    protected String getSecdocumentid() {
  -        return secdocumentid;
  -    }
  +     * Computes the document id for the destination:
  +     * new documentid = document id of the parent + last token of the id
  +     * of the source
  +     * @param firstdocumentid  The document id of the source.
  +     * @param secdocumentid  The document id of the parent of the destination.
  +     * @return String The document id of the destination.
  +     */
  +	protected String compute(String firstdocumentid, String secdocumentid) {
  +		StringTokenizer st = new StringTokenizer(firstdocumentid, "/");
  +		int l = st.countTokens();
  +
  +		for (int i = 1; i < l; i++) {
  +			st.nextToken();
  +		}
  +
  +		secdocumentid = secdocumentid + File.separator  + st.nextToken();
  +		return secdocumentid;
  +	}
   
  -    /**
  -     * set the value of the document id of the parent of the copy file.
  -     * @param documentId The document id of the parent of the copy file.
  -     */
  -    public void setSecdocumentid(String documentId) {
  -        secdocumentid = documentId;
  -    }
  -
  -    /**
  -    * Compute the unique document id for the copy file
  -    * from the document id of the copied file and this of
  -    * the parent document of the copy file.
  -      * @param firstdocumentid  The document id of the copied document
  -     * @param secdocumentid  The document id of the parent document of the copy file
  -     * @param absolutetreepath The absolute path of the tree
  -     */
  -    public void compute(String firstdocumentid, String secdocumentid, String absolutetreepath) {
  -        StringTokenizer st = new StringTokenizer(firstdocumentid, "/", true);
  -        int l = st.countTokens();
  -
  -        for (int i = 1; i < l; i++) {
  -            st.nextToken();
  -        }
  -
  -        secdocumentid = secdocumentid + "/" + st.nextToken();
  -
  -        UniqueDocumentId uniqueDocumentId = new UniqueDocumentId();
  -        secdocumentid = uniqueDocumentId.computeUniqueDocumentId(absolutetreepath, secdocumentid);
  -
  -        Target target = getOwningTarget();
  -        Project project = target.getProject();
  -        project.setProperty("node.newdocumentid", secdocumentid);
  -    }
  -
  -    /**
  -     * @see org.apache.tools.ant.Task#execute()
  -     **/
  -    public void execute() throws BuildException {
  -        try {
  -            log("first-document-id " + getFirstdocumentid());
  -            log("sec-document-id " + getSecdocumentid());
  -            log("Absolute Tree Path: " + getAbsolutetreepath());
  -            compute(getFirstdocumentid(), getSecdocumentid(), getAbsolutetreepath());
  -        } catch (Exception e) {
  -            throw new BuildException(e);
  -        }
  -    }
   }
  
  
  
  1.1                  cocoon-lenya/src/java/org/apache/lenya/cms/ant/ComputeRenameDocumentId.java
  
  Index: ComputeRenameDocumentId.java
  ===================================================================
  /*
  $Id
  <License>
  
   ============================================================================
                     The Apache Software License, Version 1.1
   ============================================================================
  
   Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
  
   Redistribution and use in source and binary forms, with or without modifica-
   tion, are permitted provided that the following conditions are met:
  
   1. Redistributions of  source code must  retain the above copyright  notice,
      this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  
   3. The end-user documentation included with the redistribution, if any, must
      include  the following  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
  
   4. The names "Apache Lenya" and  "Apache Software Foundation"  must  not  be
      used to  endorse or promote  products derived from  this software without
      prior written permission. For written permission, please contact
      apache@apache.org.
  
   5. Products  derived from this software may not  be called "Apache", nor may
      "Apache" appear  in their name,  without prior written permission  of the
      Apache Software Foundation.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
   APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
   INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
   DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
   OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
   ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
   (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
   This software  consists of voluntary contributions made  by many individuals
   on  behalf of the Apache Software  Foundation and was  originally created by
   Michael Wechner <mi...@apache.org>. For more information on the Apache Soft-
   ware Foundation, please see <http://www.apache.org/>.
  
   Lenya includes software developed by the Apache Software Foundation, W3C,
   DOM4J Project, BitfluxEditor, Xopus, and WebSHPINX.
  </License>
  */
  package org.apache.lenya.cms.ant;
  
  import java.io.File;
  import java.util.StringTokenizer;
  
  /**
   * Sets the property "newdocumentid" in the project to the value of the computed 
   * unique document id (document id of the source with the latest token 
   * replaced by the new name 
   * Used by Rename
   * @author edith
   */
  public class ComputeRenameDocumentId extends ComputeNewDocumentId {
  
  	/**
  	 * Creates a new instance of ComputeRenameDocumentId
  	 */
  	public ComputeRenameDocumentId() {
  		super();
  	}
  
  	/**
  	 * Computes the document id for the destination (renamed file):
  	 * new documentid = document id of the source, with the latest token 
  	 * replaced by the new name
  	 * @param firstdocumentid  The document id of the source.
  	 * @param secdocumentid  The new name.
  	 * @return String The document id of the destination.
  	 */
  	protected String compute(String firstdocumentid, String secdocumentid) {
  		String documentid= "";
  		StringTokenizer st = new StringTokenizer(firstdocumentid, "/");
  		int l = st.countTokens();
  		for (int i = 0; i < l-1; i++) {
  			documentid = documentid + File.separator + st.nextToken();
  		}
  		secdocumentid = documentid + File.separator + secdocumentid;
  		if (secdocumentid.startsWith(File.separator)) {
  			secdocumentid.substring(1); 
  		}
  		return secdocumentid;
  	}
  
  }
  
  
  
  1.1                  cocoon-lenya/src/java/org/apache/lenya/cms/ant/ComputeNewDocumentId.java
  
  Index: ComputeNewDocumentId.java
  ===================================================================
  /*
  $Id
  <License>
  
   ============================================================================
                     The Apache Software License, Version 1.1
   ============================================================================
  
   Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
  
   Redistribution and use in source and binary forms, with or without modifica-
   tion, are permitted provided that the following conditions are met:
  
   1. Redistributions of  source code must  retain the above copyright  notice,
      this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  
   3. The end-user documentation included with the redistribution, if any, must
      include  the following  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
  
   4. The names "Apache Lenya" and  "Apache Software Foundation"  must  not  be
      used to  endorse or promote  products derived from  this software without
      prior written permission. For written permission, please contact
      apache@apache.org.
  
   5. Products  derived from this software may not  be called "Apache", nor may
      "Apache" appear  in their name,  without prior written permission  of the
      Apache Software Foundation.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
   APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
   INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
   DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
   OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
   ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
   (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
   This software  consists of voluntary contributions made  by many individuals
   on  behalf of the Apache Software  Foundation and was  originally created by
   Michael Wechner <mi...@apache.org>. For more information on the Apache Soft-
   ware Foundation, please see <http://www.apache.org/>.
  
   Lenya includes software developed by the Apache Software Foundation, W3C,
   DOM4J Project, BitfluxEditor, Xopus, and WebSHPINX.
  </License>
  */
  package org.apache.lenya.cms.ant;
  
  import org.apache.lenya.cms.publication.UniqueDocumentId;
  
  import org.apache.tools.ant.BuildException;
  import org.apache.tools.ant.Project;
  import org.apache.tools.ant.Target;
  import org.apache.tools.ant.Task;
  
  
  /**
   * Ant task to set the property "newdocumentid" in the project with the 
   * value of computed unique document id, needed for the destination file
   * Overriden for copy/move/rename.  
   * @param absolutetreepath The path of the sitetree.
   * @param firstdocumentid The document id of the source
   * @param secdocumentid The document id of the parent of the destination
   * or in case of rename the new name
   * @author edith
   */
  public class ComputeNewDocumentId extends Task {
      private String absolutetreepath;
      private String firstdocumentid;
      private String secdocumentid;
  
      /**
       * Creates a new instance of ComputeNewDocumentId
       */
      public ComputeNewDocumentId() {
          super();
      }
  
      /**
       * @return absolutetreepath The absolute path of the tree
       */
      protected String getAbsolutetreepath() {
          return absolutetreepath;
      }
  
      /**
       * set the value of the absolute path of the tree
       * @param string The absolute path of the tree
       */
      public void setAbsolutetreepath(String string) {
          absolutetreepath = string;
      }
  
      /**
       * @return string The document id of the source 
       */
      protected String getFirstdocumentid() {
          return firstdocumentid;
      }
  
      /**
       * set the value of the document id of the source
       * @param string The document id of the source
       */
      public void setFirstdocumentid(String string) {
          firstdocumentid = string;
      }
  
      /**
       * @return string The document id of the parent of the destination
       * or the new name in case of rename
       */
      protected String getSecdocumentid() {
          return secdocumentid;
      }
  
      /**
       * @param string The document id of the parent of the destination
       * or the new name in case of rename
       */
      public void setSecdocumentid(String string) {
          secdocumentid = string;
      }
  
  	/**
  	 * Method to be overriden to compute the document id of the destination.
  	 * @param firstdocumentid The document id of the source.
  	 * @param secdocumentid Some string to characterize the destination (ex 
  	 * document id of parent, new name).
  	 * @return string. The new document id
  	 */
  	protected String compute(String firstdocumentid, String secdocumentid) {
  		return secdocumentid;
  	}
  
      /**
       * Compute the unique document id: append a "_version number" to the id,
       * if there is already a node in the sitetree with this id.
       * @param documentid  The document id.
       * @param absolutetreepath The absolute path of the tree.
       * @return newdocumentid The unique document id. 
       */
  	protected String computeUniqueId(String documentid, String absolutetreepath) {
  
          UniqueDocumentId uniqueDocumentId = new UniqueDocumentId();
          String newdocumentid = uniqueDocumentId.computeUniqueDocumentId(absolutetreepath, documentid);
  		return newdocumentid;
  
      }
  
  	/**
  	 * Set the property node.newdocumentid for the project
  	 * @param documentid The new document id.
  	 */
  	protected void setNewProperty(String documentid) {
  		Target target = getOwningTarget();
  		Project project = target.getProject();
  		project.setProperty("node.newdocumentid", documentid);
  	}
  
      /**
       * @see org.apache.tools.ant.Task#execute()
       **/
      public void execute() throws BuildException {
          try {
              log("first-document-id " + getFirstdocumentid());
              log("sec-document-id " + getSecdocumentid());
              log("Absolute Tree Path: " + getAbsolutetreepath());
              String documentId = compute(getFirstdocumentid(), getSecdocumentid());
  			String uniqueId = computeUniqueId(documentId, getAbsolutetreepath());
              setNewProperty(uniqueId);
          } catch (Exception e) {
              throw new BuildException(e);
          }
      }
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: lenya-cvs-unsubscribe@cocoon.apache.org
For additional commands, e-mail: lenya-cvs-help@cocoon.apache.org