/*
* eXist Open Source Native XML Database
* Copyright (C) 2012 The eXist Project
* 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 library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* $Id$
*/
package org.exist.storage.md.xquery;
import org.exist.dom.DocumentImpl;
import org.exist.dom.QName;
import org.exist.storage.md.Meta;
import org.exist.storage.md.MetaData;
import org.exist.storage.md.Metas;
import org.exist.xmldb.XmldbURI;
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.*;
import static org.exist.storage.md.MDStorageManager.*;
/**
*
* @author <a href="mailto:shabanovd@gmail.com">Dmitriy Shabanov</a>
* @author Casey Jordan <casey.jordan@jorsek.com>
*/
public class Keys extends BasicFunction {
private static final QName NAME = new QName("keys", NAMESPACE_URI, PREFIX);
private static final QName NAME_URL = new QName("keys-by-url", NAMESPACE_URI, PREFIX);
// private static final QName NAME_UUID = new QName("keys-by-uuid", Plugin.NAMESPACE_URI, Plugin.PREFIX);
private static final String DESCRIPTION = "Get the set of keys for a document's metadata record";
private static final FunctionReturnSequenceType RETURN = new FunctionReturnSequenceType(Type.STRING, Cardinality.ZERO_OR_MORE, "The resource's metadata field keys");
public final static FunctionSignature signatures[] = {
new FunctionSignature(
NAME,
DESCRIPTION,
new SequenceType[] {
new FunctionParameterSequenceType("resource", Type.ITEM, Cardinality.EXACTLY_ONE, "Document")
},
RETURN
),
new FunctionSignature(
NAME_URL,
DESCRIPTION,
new SequenceType[] {
new FunctionParameterSequenceType("resource", Type.STRING, Cardinality.EXACTLY_ONE, "Document's URL")
},
RETURN
)
// ,
// new FunctionSignature(
// NAME_UUID,
// DESCRIPTION,
// new SequenceType[] {
// new FunctionParameterSequenceType("resource", Type.STRING, Cardinality.EXACTLY_ONE, "Resource UUID")
// },
// RETURN
// )
};
/**
* @param context
*/
public Keys(XQueryContext context, FunctionSignature signature) {
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 {
Metas metas = null;
if (getSignature().getName().equals(NAME))
if (args[0] instanceof DocumentImpl) {
metas = MetaData.get().getMetas(((DocumentImpl)args[0]));
} else
throw new XPathException(this, "Unsupported type "+args[0].getItemType());
else if (getSignature().getName().equals(NAME_URL))
metas = MetaData.get().getMetas(XmldbURI.create(args[0].getStringValue()));
if (metas == null)
throw new XPathException(this, "No metadata found.");
ValueSequence returnSeq = new ValueSequence();
for (Meta meta : metas.metas()) {
returnSeq.add(new StringValue(meta.getKey()));
}
return returnSeq;
}
}