Xindice API
version 1.2m1

org.apache.xindice.server.rpc.messages
Class GetDocumentMeta

java.lang.Object
  extended byorg.apache.xindice.server.rpc.RPCDefaultMessage
      extended byorg.apache.xindice.server.rpc.messages.GetDocumentMeta
All Implemented Interfaces:
RPCMessage

public class GetDocumentMeta
extends RPCDefaultMessage

XML-RPC message to fetch the meta data associated with a document

Version:
$Revision: 595817 $, $Date: 2007-11-16 15:49:03 -0500 (Fri, 16 Nov 2007) $
Author:
Dave Viner

Field Summary
 
Fields inherited from class org.apache.xindice.server.rpc.RPCDefaultMessage
API_NAME, API_VERSION, COLLECTION, COMPRESSED, CONFIGURATION, DOCUMENT, MAXKEYSIZE, META, MISSING_COLLECTION_PARAM, MISSING_CONFIGURATION_PARAM, MISSING_DOCUMENT_PARAM, MISSING_META_CONFIGURATION, MISSING_META_PARAM, MISSING_NAME_PARAM, MISSING_PATTERN_PARAM, MISSING_QUERY_PARAM, MISSING_TIMESTAMP_PARAM, MISSING_TYPE_PARAM, NAME, NAMESPACES, PAGESIZE, PATTERN, QUERY, RESULT, TIMESTAMP, TYPE
 
Constructor Summary
GetDocumentMeta()
           
 
Method Summary
 Map execute(Map message)
          Return the MetaData object for the requested document.
 
Methods inherited from class org.apache.xindice.server.rpc.RPCDefaultMessage
getCollection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetDocumentMeta

public GetDocumentMeta()
Method Detail

execute

public Map execute(Map message)
            throws Exception
Return the MetaData object for the requested document. This method expects the Map to contain the name of the collection in the RPCDefaultMessage.COLLECTION key, and the name of the document in the RPCDefaultMessage.NAME key. It will return an XML representation of the MetaData object associated with this document. The XML will be stored in the RPCDefaultMessage.RESULT key.

Parameters:
message - the parameters passed to the xmlrpc method.
Returns:
Map containing the XML for the requested MetaData object.
Throws:
Exception

Xindice API
version 1.2m1

Copyright (c) 1999-2007 The Apache Software Foundation. All Rights Reserved.