[Exist-commits] eXist-1.0/src/org/exist/xquery/functions/util LockFunction.java,NONE,1.1 SharedLockFunction.java,NONE,1.1 ExclusiveLockFunction.java,NONE,1.1 ModuleImpl.java,1.6,1.7

[Wolfgang M. M. <wol...@us...>]

Update of /cvsroot/exist/eXist-1.0/src/org/exist/xquery/functions/util
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv3520/src/org/exist/xquery/functions/util

Modified Files:
	ModuleImpl.java 
Added Files:
	LockFunction.java SharedLockFunction.java 
	ExclusiveLockFunction.java 
Log Message:
Added new functions exclusive-lock and shared-lock.

--- NEW FILE: LockFunction.java ---
/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2001-04 Wolfgang M. Meier
 *  wol...@ex...
 *  http://exist-db.org
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 * 
 *  $Id: LockFunction.java,v 1.1 2004/06/02 11:33:30 wolfgang_m Exp $
 */
package org.exist.xquery.functions.util;

import org.exist.dom.DocumentSet;
import org.exist.util.LockException;
import org.exist.xquery.Function;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.XPathException;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.Item;
import org.exist.xquery.value.Sequence;


public abstract class LockFunction extends Function {

    protected boolean exclusive = false;
    
    protected LockFunction(XQueryContext context, FunctionSignature signature, boolean exclusive) {
        super(context, signature);
        this.exclusive = exclusive;
    }
    
    /* (non-Javadoc)
     * @see org.exist.xquery.Function#eval(org.exist.xquery.value.Sequence, org.exist.xquery.value.Item)
     */
    public Sequence eval(Sequence contextSequence, Item contextItem)
            throws XPathException {
        Sequence docsArg = getArgument(0).eval(contextSequence, contextItem);
        DocumentSet docs = docsArg.getDocumentSet();
        try {
            docs.lock(exclusive);
            return getArgument(1).eval(contextSequence, contextItem);
        } catch (LockException e) {
            throw new XPathException(getASTNode(), "Could not lock document set", e);
        } finally {
            docs.unlock(exclusive);
        }
    }
    
    
    /* (non-Javadoc)
     * @see org.exist.xquery.Function#getCardinality()
     */
    public int getCardinality() {
        return getArgument(1).getCardinality();
    }
    
    
    /* (non-Javadoc)
     * @see org.exist.xquery.Function#returnsType()
     */
    public int returnsType() {
        return getArgument(1).returnsType();
    }
}

Index: ModuleImpl.java
===================================================================
RCS file: /cvsroot/exist/eXist-1.0/src/org/exist/xquery/functions/util/ModuleImpl.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** ModuleImpl.java	28 May 2004 10:54:21 -0000	1.6
--- ModuleImpl.java	2 Jun 2004 11:33:30 -0000	1.7
***************
*** 44,48 ****
  		new FunctionDef(CollectionName.signature, CollectionName.class),
  		new FunctionDef(LogFunction.signature, LogFunction.class),
! 		new FunctionDef(CatchFunction.signature, CatchFunction.class)
  	};
  	
--- 44,50 ----
  		new FunctionDef(CollectionName.signature, CollectionName.class),
  		new FunctionDef(LogFunction.signature, LogFunction.class),
! 		new FunctionDef(CatchFunction.signature, CatchFunction.class),
! 		new FunctionDef(ExclusiveLockFunction.signature, ExclusiveLockFunction.class),
! 		new FunctionDef(SharedLockFunction.signature, SharedLockFunction.class)
  	};
  	

--- NEW FILE: ExclusiveLockFunction.java ---
/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2001-04 Wolfgang M. Meier
 *  wol...@ex...
 *  http://exist-db.org
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 * 
 *  $Id: ExclusiveLockFunction.java,v 1.1 2004/06/02 11:33:30 wolfgang_m Exp $
 */
package org.exist.xquery.functions.util;

import org.exist.dom.QName;
import org.exist.xquery.Cardinality;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;

public class ExclusiveLockFunction extends LockFunction {

    public final static FunctionSignature signature =
		new FunctionSignature(
			new QName("exclusive-lock", ModuleImpl.NAMESPACE_URI, ModuleImpl.PREFIX),
			"Puts an exclusive lock on the owner documents of all nodes in the first argument, $a. " +
			"Then calls the expression in the second argument, $b and releases the acquired locks after" +
			"its completition.",
			new SequenceType[] {
				new SequenceType(Type.NODE, Cardinality.ONE_OR_MORE),
				new SequenceType(Type.ITEM, Cardinality.ZERO_OR_MORE)
			},
			new SequenceType(Type.ITEM, Cardinality.EMPTY));
    
    public ExclusiveLockFunction(XQueryContext context) {
        super(context, signature, true);
    }

}

--- NEW FILE: SharedLockFunction.java ---
/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2001-04 Wolfgang M. Meier
 *  wol...@ex...
 *  http://exist-db.org
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 * 
 *  $Id: SharedLockFunction.java,v 1.1 2004/06/02 11:33:30 wolfgang_m Exp $
 */
package org.exist.xquery.functions.util;

import org.exist.dom.QName;
import org.exist.xquery.Cardinality;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;


public class SharedLockFunction extends LockFunction {

    public final static FunctionSignature signature =
		new FunctionSignature(
			new QName("shared-lock", ModuleImpl.NAMESPACE_URI, ModuleImpl.PREFIX),
			"Puts a shared lock on the owner documents of all nodes in the first argument, $a. " +
			"Then calls the expression in the second argument, $b and releases the acquired locks after" +
			"its completition.",
			new SequenceType[] {
				new SequenceType(Type.NODE, Cardinality.ONE_OR_MORE),
				new SequenceType(Type.ITEM, Cardinality.ZERO_OR_MORE)
			},
			new SequenceType(Type.ITEM, Cardinality.EMPTY));
    
    public SharedLockFunction(XQueryContext context) {
        super(context, signature, false);
    }
}