org.atombeat.xquery.functions.util.GetZipEntryCrc.java Source code

Introduction

Here is the source code for org.atombeat.xquery.functions.util.GetZipEntryCrc.java

Source

/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2001-09 Wolfgang M. Meier
 *  wolfgang@exist-db.org
 *  http://exist.sourceforge.net
 *  
 *  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: GetData.java 9749 2009-08-09 23:18:12Z ixitar $
 */
package org.atombeat.xquery.functions.util;

import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.exist.dom.QName;
import org.exist.xquery.BasicFunction;
import org.exist.xquery.Cardinality;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.XPathException;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.FunctionParameterSequenceType;
import org.exist.xquery.value.FunctionReturnSequenceType;
import org.exist.xquery.value.IntegerValue;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;

/**
 */
public class GetZipEntryCrc extends BasicFunction {

    protected static final Log log = LogFactory.getLog(GetZipEntryCrc.class);

    public final static FunctionSignature signature = new FunctionSignature(
            new QName("get-zip-entry-crc", AtomBeatUtilModule.NAMESPACE_URI, AtomBeatUtilModule.PREFIX),
            "Return CRC of zip entry.",
            new SequenceType[] {
                    new FunctionParameterSequenceType("path", Type.STRING, Cardinality.EXACTLY_ONE,
                            "The path of the zip file."),
                    new FunctionParameterSequenceType("entry", Type.STRING, Cardinality.EXACTLY_ONE,
                            "The name of the zip entry.") },
            new FunctionReturnSequenceType(Type.INTEGER, Cardinality.ZERO_OR_ONE, "CRC of zip entry if present"));

    public GetZipEntryCrc(XQueryContext context) {
        super(context, signature);
    }

    /* (non-Javadoc)
     * @see org.exist.xquery.BasicFunction#eval(org.exist.xquery.value.Sequence[], org.exist.xquery.value.Sequence)
     */
    public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {

        try {
            ZipFile zf = new ZipFile(args[0].getStringValue());
            ZipEntry ze = zf.getEntry(args[1].getStringValue());
            return new IntegerValue(ze.getCrc());
        } catch (Exception e) {
            throw new XPathException("error processing zip file: " + e.getLocalizedMessage(), e);
        }

    }

}