/* -*-Java-*-

********************************************************************************

*

* File:         DLIOPwrapper.java

* RCS:          $Header: /u/testbed/CVSROOT/dldev/doc/Visigenic/InfoBus/StreetRouterProxy/DLIOPwrapper.java,v 1.1 1998/05/19 23:23:34 paepcke Exp $

* Description:  Handler for the Stanford InfoBus DLIOP Protocol

* Author:       Gerard Rodriguez, Stanford University

* Created:      Wed Jan 15 11:14:50 1998

* Modified:     Thu Apr 16 13:50:14 1998 (Andreas Paepcke) paepcke@SNUGGLES

* Language:     Java

* Package:      N/A

* Status:       Experimental (Do Not Distribute)

*

* (c) Copyright 1998, Stanford University, all rights reserved.

*

********************************************************************************

*

* Revisions:

*

* Wed Apr 15 11:15:44 1998 (Andreas Paepcke) paepcke@SNUGGLES

*  Changed to conform to our new specification of collection plugs.

********************************************************************************

*/



// Do do:

//    - fix a bit of grammar



/**

DLIOPwrapper.java implements the part of the INFOBUS Proxy that deals

with the DLIOP protocol. Its methods are invoked from remote objects

via CORBA calls. In order to do their work, they call the methods

of another module, called a 'collection plug'. While the DLIOPwrapper

is the same for all search proxies, collection plugs are specialized

to accessing particular collections, though they have a very clear

small interface which we invoke from this DLIOPwrapper module.

<p>

As far as CORBA interfaces go, an InfoBus Proxy is a

CConstrainCollection object. DLIOPwrapper.java implements all the

DLIOP methods that a INFOBUS Proxy should be able to answer.

<p>

You don't really need to understand this file. You should only

need to modify the CollectionPlug file. 

<p>

For further documentation: About DLIOP, see 

   http://www-diglib.stanford.edu/cgi-bin/WP/get/SIDL-WP-1997-0054

For an explanation of what collection plugs do, see: ****

<p>

To understand everything in detail, please check that DLIOP

URL. Just in summary, a search proceeds when the client calls

RequestConstrain, passing the pointer to an object called a result

collection. That object typically resides at the client's

site. This DLIOPwrapper module processes the search with the help

of the underlying collection plug. I then adds the resulting

information to the result collection by way of remote method calls.

<p>

The main task of all the methods in this module is to take the

parameters passed into them, to unpack them, to invoke the proper

service method in the collection plug, to pack the return

parameters, and to return them to the caller. What makes this

module somewhat hard to understand is mostly the packing and

unpacking of the parameters. For example, when 10 documents are

returned, and each has title, author and date, then the information

is packed into a 10 by 3 matrix. This matrix is then made part of

the final return data structure which contains some additional

information. The reason we do this, rather than the obvious of

making each document into an object and just returning an array of

those objects, is that so far, CORBA does not provide

pass-by-value. This means that the returned objects would all just

be pointers. Whenever the client would pull some information out of

a document (like the author or the title), this would be a remote

method invocation. That is too much of a performance drain. Once

pass-by-value is available, we can re-design the DLIOP protocol to

be much simpler.

*/



import IDLInterchange.*;

import CosPropertyService.*;



public class DLIOPwrapper extends CConstrainCollectionImpl {



  // Please, set this to the name of this proxy

  public final static String SERVICE_NAME = "StreetRouter";



  // An array of CollectionPlugs, this proxy can deal with

  // several CollectionPlugs at the same time.

  static final short MAX_COLPLUGS = 50;

  private CollectionPlug[] colplugs = new CollectionPlug[MAX_COLPLUGS];

  private short colplugspointer;



  // USMarc <-> English translator

  USMarc lusmarc = new USMarc();



  // A pointer to the ORB in the StreetServer class

  private org.omg.CORBA.ORB orb;



  // Constructors for this class

  public DLIOPwrapper () {

        super();

        Init();

  }



  public DLIOPwrapper (String name) {

        super(name);

        Init();

  }



  public DLIOPwrapper (String name,  org.omg.CORBA.ORB porb ) {

        super(name);

        Init();

        orb = porb;

  }



  public void CancelRequest(

                CosPropertyService.Any pMessageID) throws

                            IDLInterchange.InvalidMessageID {

    // In the framework of the implementation of this proxy

    // it is not possible to cancel an ongoing request, since the

    // results are sent all together.

    return;

  }



  //RequestItemsProperties

  //

  //Request to be sent properties of items given their server-side

  //cookies.

  //

  //Sometime later, one or more SetItemsProperties messages will be sent to

  //pResultTarget and finally a CompletedRequest() or RaiseException()

  //will be sent to signal the end of the request.

  //

  //  o pMessageID is the client-side data to pass back in order to

  //    identify the resulting callback messages.

  //  o pPropertyNames are the list of fields desired.

  //  o pServerCookies is a list of server-side cookies of the items

  //    requested.

  //  o pClientCookies is a list of client-side cookies to be returned

  //    in conjuction with the items' state information.  The client can

  //    place anything in these cookies and is guarateed to be matched

  //    up with the resulting items.

  //  o pResultTarget is the target result collection to send the Items to.



  public void RequestItemsProperties(

              CosPropertyService.Any pMessageID,

              java.lang.String[] pPropertyNames,

              CosPropertyService.Any[] pServerCookies,

              CosPropertyService.Any[] pClientCookies,

              IDLInterchange.CCollection pResultTarget) {



    System.out.println("RequestItemsProperties");



    IDLInterchange.TException pException =

                new IDLInterchange.TException();



    if ( pResultTarget == null ) {

      // No ResultTarget

      System.out.println("No valid Result Collection in the parameters");

      return;

    }

    if ( pPropertyNames.length == 0 ) {

      // No properties

      System.out.println("No properties in the parameters");

      pException.aRequestReason("No properties in the parameters");

      pResultTarget.RaiseException(pMessageID,pException);

      return;

    }

    if ( pServerCookies.length == 0 ) {

      // No cookies

      System.out.println("pServerCookies equals 0");

      pResultTarget.CompletedRequest(pMessageID);

      return;

    }

    if ( pServerCookies.length != pClientCookies.length ) {

      // Error.

      System.out.println("Unmatching number of Client Side Cookies");

      pException.aRequestReason("Unmatching number of Client Side Cookies");

      pResultTarget.RaiseException(pMessageID,pException);

    }



    IDLInterchange.TItemsCookieState pItems =

                new IDLInterchange.TItemsCookieState();

    try {

      pItems.aStates = pack_properties(pServerCookies, 

                                       pPropertyNames,

				       pResultTarget);

      System.out.println("Properties packed");

      pItems.aClientCookies = pClientCookies;

      pResultTarget.SetItemsProperties(pMessageID,

                                       pItems);

      pResultTarget.CompletedRequest(pMessageID);

    }

    catch (Exception e) {

      // Something went wrong

      System.out.println(e);

      pException.aRequestReason("Error retrieving the properties");

      pResultTarget.RaiseException(pMessageID,pException);

    }

    return;

  }



  //GetItemsPropertyNames

  //

  //For a list of items, return a list of valid property names.



  public java.lang.String 

          GetItemsPropertyNames(CosPropertyService.Any[] pCookies)[][] throws

                                        IDLInterchange.InvalidRequest,

                                        IDLInterchange.InvalidCookies,

                                        IDLInterchange.InvalidAuthenication,

                                        IDLInterchange.InvalidPayment,

                                        IDLInterchange.MultipleExceptions {

    System.out.println("GetItemsPropertyNames");



    CollectionPlug colplug = new CollectionPlug();

    int numOfProps = colplug.GetDefaultPropertyNames().length;

    if (pCookies.length == 0) {

        //Compatibility with AsynInterClient.py (Old InfoBus)

        // It needs to be changed

        String[][] propos = new String[1][numOfProps];

        propos[0] = colplug.GetDefaultPropertyNames();

        propos[0] = ToUSMarc(propos[0]);

        return (propos);

    }



    String[][] aux = new String[pCookies.length][numOfProps];

    short tablepos;

    int numberofdoc;

    for(int i=0;i<pCookies.length;i++) {

        tablepos = GetCollectionPlug(pCookies[i]);

        numberofdoc = GetDocPos(pCookies[i]);

        aux[i] = colplugs[tablepos].GetPropertyNames(numberofdoc);

        aux[i] = ToUSMarc(aux[i]);

    }

    return(aux);

  }



  //RequestConstrain()



  //   Request to constrain Collection with pDesignator and send results

  //   to pTarget.

  //

  //   Sometime later, one or more AddItems messages will be sent to

  //   pResultTarget and finally a CompletedRequest() or RaiseException()

  //   will be sent to signal the end of the request.

  //

  //     o pMessageID is the client-side data to pass back in order to

  //       identify the resulting callback messages.

  //     o pQuerySummary is the constraints to place on this collection.

  //     o pServicePrefSummary are miscellaneous preferences like quality of

  //           service, passwords, flow control, number of itmes to send now.

  //     o pPropertyNames are the list of fields desired.

  //     o pTarget is the result collection to send the Items to.

  //



  public void RequestConstrain(

              CosPropertyService.Any pMessageID,

              IDLInterchange.TQuerySummary pQuerySummary,

              IDLInterchange.TServicePrefSummary pServicePrefSummary,

              IDLInterchange.CCollection pResultTarget) {



    System.out.println("RequestConstrain ProxyImpl\n");

    IDLInterchange.TException pException =

                new IDLInterchange.TException();



    if (pResultTarget == null) {

      // No ResultTarget

      System.out.println("No valid Result Collection in the parameters");

      return;

    }




    //Extracting the query parameters.

    int maxhits = pServicePrefSummary.aNumberOfItems;

    

    System.out.println("Value of maxhits: " + maxhits);



    CosPropertyService.Any anytypequery =

          (pQuerySummary.aQueryDescription.QueryType0()).query;



    // Here we extract the query from a CosProperty.Any object

    // depending on what type of object we have

    // Once we have the object, we transform this object to a String

    // because it is what we need in the CollectionPlug



    String lquery = "";

    CosPropertyService.anyType disc = anytypequery.discriminator();

    if ( disc ==

        (CosPropertyService.anyType) CosPropertyService.anyType.Any_string)

      lquery = anytypequery.a_string();

    if ( disc ==

        (CosPropertyService.anyType) CosPropertyService.anyType.Any_sequenceAny) {

      CosPropertyService.Any[] listofanys = anytypequery.a_sequenceany();

      for(int i=0;i<listofanys.length;i++) {

        // here we assume that what we have is a list of strings....

        lquery = lquery.concat(listofanys[i].a_string());

        if ( i < (listofanys.length -1) ) {

          lquery = lquery.concat(" ");

        }

      }

    }



    System.out.println("Query request: " + lquery);



    try {

      short pointer = getNewCollectionPlug();

      System.out.println("Search through new collection plug entry " + pointer + " in colplugs table");

      int total = colplugs[pointer].Search(lquery,maxhits);

      System.out.println("Collection plug returned total = " + total);

      pResultTarget.SetTotalItems(total);



      // In the plug: set the properties we want to extract from each document.

      // We translate from USMarc to English as well

      try {  

        colplugs[pointer].SetProperties(

           lusmarc.USMarc2English(pQuerySummary.aItemPropertyNames));

      }

      catch (java.lang.IllegalArgumentException e) {

        pException.aRequestReason(

          "Illegal set of properties.");

        pResultTarget.RaiseException(pMessageID,pException);

        // The Request has been completed. We let the result know

        pResultTarget.CompletedRequest(pMessageID);

        return;

      }

        

      // Check how many of the properties were acceptable to the plug:

      int numOfProps = colplugs[pointer].GetPropertyNames().length;



      if ((total == 0) || (numOfProps == 0) ) {

        pResultTarget.CompletedRequest(pMessageID);

        return;

      }

      // Now we pack all the documents in a TItemsACState structure to

      // send them to the ResultTarget



      IDLInterchange.TItemsACState pItems =

                  new IDLInterchange.TItemsACState();

      try {

      pItems = pack_docs(colplugs[pointer],pointer, total);
    
      }

      catch (java.lang.ArrayIndexOutOfBoundsException e) {

        // The exception will include the index into the result collection

	// that did not work:

        pException.aRequestReason(

          "A referenced document was unavailable in the proxy. " + 

          e.getMessage());

        pResultTarget.RaiseException(pMessageID,pException);

        // The Request has been completed. We let the result know

        pResultTarget.CompletedRequest(pMessageID);

        return;

      }



      // Now, it's time to set pNewMoreCookie. Here we specify the contact

      // points for the objects from where we can get more docs

      IDLInterchange.TAccessOption[] pNewMoreCookie =

                  new IDLInterchange.TAccessOption [1]; // Only one, the proxy

      pNewMoreCookie = pack_more_cookie(colplugs[pointer],pointer);



      // Now that we have everything, we call the resultarget method addItems

      pResultTarget.AddItems(pMessageID, pItems, pNewMoreCookie);



      // The Request has been completed. We let the result know

      pResultTarget.CompletedRequest(pMessageID);

    }

    catch (Exception e) {

        System.out.println("Exception caught: " + e);

        e.printStackTrace();

        pException.aRequestReason(e.toString());

        pResultTarget.RaiseException(pMessageID,pException);

        // The Request has been completed. We let the result know

        pResultTarget.CompletedRequest(pMessageID);

    }



    return;

  }



  //RequestItems()



  //   Request to be sent pNumberItems more Items to pTarget.

  //   Sometime later, one or more AddItems messages will be sent to

  //   pResultTarget and finally a CompletedRequest() or RaiseException()

  //   will be sent to signal the end of the request.

  //

  //     o pPropertyNames are the list of fields desired.

  //     o pMoreCookie was returned to the client by AddItems that 

  //       It contains the instructions of how to

  //       get more Items in the collection.  A value of NIL means to

  //       start from the beginning of the collection.

  //     o pNumberItems represents the maximum number of Items

  //       to send back.  If -1, then return all of the items in

  //       this collection.

  //     o pTarget is the result collection to send the Items to.

 

  public void RequestItems(

              CosPropertyService.Any pMessageID,

              java.lang.String[] pPropertyNames,

              CosPropertyService.Any pMoreCookie,

              int pNumberItems,

              IDLInterchange.CCollection pResultTarget) {



    IDLInterchange.TException pException =

                new IDLInterchange.TException();



    System.out.println("RequestItems");

    // Requesting more items

    // pMessageID is not used by now. Should it be the form of identification?

    // By now, my form of identification is pMoreCookie

    // In pMoreCookie a have something like Ex:y

    // it means, is the entry x, and I got y elements



    if (pResultTarget == null) {

      // No ResultTarget

      System.out.println("No valid Result Collection in the parameters");

      return;

    }



    // Get the collection plug that handles this:

    short tablepos = GetCollectionPlug(pMoreCookie);

    int initialDocCursor = GetDocPos(pMoreCookie);

    System.out.println("The cookie has: " + tablepos +

                       " " + initialDocCursor);

    // The CollectionPlug is colplugs[tablepos]

    // See if we have pending docs in that connection

    try {

      // We'll bomb out of here if we try to get more items

      // from the collection plug than it can get.



      // First, we have to set the properties we want to be 

      // included in every document:

      try {

        colplugs[tablepos].SetProperties(

                        lusmarc.USMarc2English(pPropertyNames));

      }

      catch (java.lang.IllegalArgumentException e) {

        pException.aProperties(pPropertyNames);

        pResultTarget.RaiseException(pMessageID,pException);

      }

      // Check how many of the properties were acceptable to the plug:

      int numOfProps = colplugs[tablepos].GetPropertyNames().length;



      if (numOfProps == 0) SignalNoResult(pResultTarget, pMessageID);



      // Now we pack all the documents in a TItemsACState data structure

      // to send them to the ResultTarget:



      IDLInterchange.TItemsACState pItems =

              new IDLInterchange.TItemsACState();

      try {

        pItems = pack_docs(colplugs[tablepos],tablepos, pNumberItems);

      }

      catch (java.lang.ArrayIndexOutOfBoundsException e) {

        // The exception will include the index into the result collection

	// that did not work:

        pException.aRequestReason(

          "A referenced document was unavailable in the proxy. " + 

          e.getMessage());

        pResultTarget.RaiseException(pMessageID,pException);

      }



      pResultTarget.SetTotalItems(colplugs[tablepos].DocCursor() - initialDocCursor);



      // Now, it's time to set pNewMoreCookie. Here we especify the contact

      // points for the objects from where we can get more docs

      IDLInterchange.TAccessOption[] pNewMoreCookie =

              new IDLInterchange.TAccessOption [1]; // Only one, the proxy

      pNewMoreCookie = pack_more_cookie(colplugs[tablepos],tablepos);



      // Now that we have everything, we call the resultarget method addItems

      pResultTarget.AddItems(pMessageID, pItems, pNewMoreCookie);



      // The Request has been completed. We let the result know

      pResultTarget.CompletedRequest(pMessageID);

    }

    catch (java.lang.ArrayIndexOutOfBoundsException e) {

      pResultTarget.SetTotalItems(colplugs[tablepos].DocCursor() - initialDocCursor);

      pResultTarget.CompletedRequest(pMessageID);

    }

    return;

  }



  //SignalNoResult

  //Tell client's result collection that there was nothing to send back

  //to it:

  private void SignalNoResult(IDLInterchange.CCollection clientCol,

                              CosPropertyService.Any msgID) {

        System.out.println("Indicating empty return");

        clientCol.SetTotalItems(0);

        // The Request has been completed. We let the result know

        clientCol.CompletedRequest(msgID);

  }



  //GetItemsProperties

  //

  //   Get properties of items given their service-side cookies.

  //

  //     o pPropertyNames are the list of fields desired.

  //     o pServerCookies is a list of server-side cookies of the items

  //       requested.

  //

  //   Note: order and size of result TItemsState must match the

  //         order and size of the pServerCookies parameter.



  public IDLInterchange.TItemsState GetItemsProperties(

                        java.lang.String[] pPropertyNames,

                        CosPropertyService.Any[] pServerCookies) throws

                                IDLInterchange.InvalidRequest,

                                IDLInterchange.InvalidAuthenication,

                                IDLInterchange.InvalidPayment,

                                IDLInterchange.InvalidCookies,

                                IDLInterchange.InvalidProperties,

                                IDLInterchange.MultipleExceptions {



    System.out.println("GetItemsProperties");

    IDLInterchange.TItemsState aState =

                new IDLInterchange.TItemsState();



    // Extracting the CollectionPlug from the cookie Ex:y



    String stringcookie = pServerCookies[0].a_string();

    short tablepos = GetCollectionPlug(pServerCookies[0]);



    if ( (pPropertyNames.length == 0) || ( pPropertyNames == null)  ) {

      // pPropertyNames is null, sending back all the properties I have

      // about all the objects that I have.

      // Setting aNames

      int numOfProps = colplugs[tablepos].GetPropertyNames().length;

      String[] aNames = new String[numOfProps];

      aNames = colplugs[tablepos].GetPropertyNames();



      //Setting anItemsState

      CosPropertyService.Any[][] anItemsState =

                new CosPropertyService.Any [colplugs[tablepos].TotalItems()]

                                           [numOfProps];

      int i=0;

      while ( i< colplugs[tablepos].TotalItems()){

	try {

          anItemsState[i] = GetPropertyValues(i,colplugs[tablepos]);

	}

        catch (java.lang.ArrayIndexOutOfBoundsException e) {

          // Make an object of type 'any' from the integer i:

          CosPropertyService.Any badIndex = new CosPropertyService.Any();

          badIndex.a_ulong(i);

          CosPropertyService.Any [] badCookies = {badIndex};

          throw new 

            IDLInterchange.InvalidCookies(badCookies);

        }

        i++;

      }

      //Packing all the info

      aState.aNames = ToUSMarc(aNames);

      aState.anItemsState = anItemsState;

    } else {

      // pPropertyNames is non-empty, so, it comes from

      // AsynInterClient and the value is somethin like ['100'] (USMARC)

      // Needs translation using USMarc.java



      System.out.println("Making USMarc translations..." +

                          pPropertyNames.length);



      USMarc lusmarc = new USMarc();



      String[] aNames = new String[pPropertyNames.length];

      for (int i=0;i<pPropertyNames.length;i++) {

        aNames[i] = pPropertyNames[i];

        System.out.println(aNames[i] + "*" +

                        lusmarc.USMarc2English(aNames[i]));

      }



      //Setting anItemsState

      CosPropertyService.Any[][] anItemsState =

                new CosPropertyService.Any [pServerCookies.length]

                                           [pPropertyNames.length];

      int i=0;

      while ( i< pServerCookies.length){

	try {

          anItemsState[i] = GetPropertyValues(i,colplugs[tablepos],

                            lusmarc.USMarc2English(pPropertyNames));

	}

        catch (java.lang.IllegalArgumentException e) {

          throw new IDLInterchange.InvalidProperties(pPropertyNames);

        }

        catch (java.lang.ArrayIndexOutOfBoundsException e) {

          // Make an object of type 'any' from the integer i:

          CosPropertyService.Any badIndex = new CosPropertyService.Any();

          badIndex.a_ulong(i);

          CosPropertyService.Any [] badCookies = {badIndex};

          throw new 

            IDLInterchange.InvalidCookies(badCookies);

        }

        i++;

      }

      //Packing all the info

      aState.aNames = aNames;

      aState.anItemsState = anItemsState;

    }

    return(aState);

  }





  // From now on...  Local procedures



  // pack_more_cookie

  // Packs the capabilities for a given CollectionPlug



  private IDLInterchange.TAccessOption[] pack_more_cookie (

                        CollectionPlug colplug,

                        short pointer ) {

    //Pointer is used for the Cookie: E'pointer':'number of doc'



    IDLInterchange.TAccessOption[] pNewMoreCookie =

                new IDLInterchange.TAccessOption [1]; // Only one, the proxy



    // The aTarget is myself so, aTarget = this. I'm the only one

    // able to respond to queries, I'm the proxy!!!!

    IDLInterchange.CItem aTarget = this;



    // anItemClass, by now is not used

    String anItemClass = "";



    // aHints, by now is not used, just set tto make the compiler happy.

    CosPropertyService.Property[] aHints =

                new CosPropertyService.Property[1];

    short garbage = 0;

    CosPropertyService.Any Garbage =

                new CosPropertyService.Any();

    Garbage.a_short(garbage);

    CosPropertyService.Property property =

                new CosPropertyService.Property("",Garbage);

    aHints[0] = property;



    // The aCookie tells me what was the last object

    CosPropertyService.Any aCookie = new CosPropertyService.Any();

    // Setting the cookie -> E'pointer':'number of doc'

    String forcookies = "E";

    forcookies = forcookies.concat(String.valueOf(pointer));

    forcookies = forcookies.concat(":");

    forcookies = forcookies.concat(String.valueOf(colplug.TotalItems()));

    aCookie.a_string(forcookies);



    pNewMoreCookie[0] = new IDLInterchange.TAccessOption(

                        aTarget, aCookie, anItemClass, aHints);



    return pNewMoreCookie; 

  }



  // pack_properties

  // Packs the property values of a set of documents identified

  // by pServerCookies.



  private IDLInterchange.TItemsState pack_properties(

                CosPropertyService.Any[] pServerCookies,

                String[] pPropertyNames,

                IDLInterchange.CCollection pResultTarget) throws Exception{





    IDLInterchange.TException pException =

                new IDLInterchange.TException();



    IDLInterchange.TItemsState result =

                new IDLInterchange.TItemsState();

    short tablepos;

    int indexdoc;

    // Do I have these properties?

    System.out.println("Packing properties");

    if (!CollectionPlug.CheckPropAvailability(lusmarc.USMarc2English(pPropertyNames))) {

      System.out.println("I don't have this set of properties");

      throw new Exception();

    } else {

      System.out.println("Right set of properties");

    }



    result.aNames = pPropertyNames;

    CosPropertyService.Any[][] anItemsState =

                new CosPropertyService.Any [pServerCookies.length]

                                           [pPropertyNames.length];



    for(int i =0;i<pServerCookies.length;i++) {

      tablepos = GetCollectionPlug(pServerCookies[i]);

      indexdoc = GetDocPos(pServerCookies[i]);

      if ( colplugs[tablepos].TotalItems() < (indexdoc + 1) ) {

        System.out.println("Cookie points to a free entry");

        throw new Exception();

      }

      try {

      colplugs[tablepos].SetProperties(

                lusmarc.USMarc2English(pPropertyNames));

      }

      catch (java.lang.IllegalArgumentException e) {

        throw new IDLInterchange.InvalidProperties(pPropertyNames);

      }



      try {

        anItemsState[i] = GetPropertyValues(indexdoc,

                                            colplugs[tablepos]);

      }

      catch (java.lang.ArrayIndexOutOfBoundsException e) {

        // Make an object of type 'any' from the integer i:

        CosPropertyService.Any badIndex = new CosPropertyService.Any();

        badIndex.a_ulong(i);

        CosPropertyService.Any [] badCookies = {badIndex};

        throw new 

          IDLInterchange.InvalidCookies(badCookies);

      }

    }

    result.anItemsState = anItemsState;

    

    return result;

  }



  // pack_docs

  // Packs the values of the properties of the requested number

  // of documents in a given CollectionPlug into a TItemsACState

  // data structure:



  private IDLInterchange.TItemsACState pack_docs (

                        CollectionPlug colplug,

                        short pointer,

                        int numDocs) {

    //Pointer is used for the Cookie: E'pointer':'number of doc'



    // Setting up the part of the data structure that is common

    // to all requests:



    // The aTarget is myself so, aTarget = this. I'm the only one

    // able to respond to queries, I'm the proxy!!!!

    IDLInterchange.CItem aTarget = this;



    // anItemClass, is not used for now:

    String anItemClass = "";



    // aHints, by now is not used. Set to make the compiler happy.

    CosPropertyService.Property[] aHints =

                new CosPropertyService.Property[1];

    short garbage = 0;

    CosPropertyService.Any Garbage =

                new CosPropertyService.Any();

    Garbage.a_short(garbage);

    CosPropertyService.Property property =

                new CosPropertyService.Property("",Garbage);

    aHints[0] = property;



    // Here we put the names of the properties of the records 

    // that were requested (by a previous SetProperties() call):

    int numOfProps = colplug.GetPropertyNames().length;

    String[] aNames = new String[numOfProps];

    String[] auxstrings = colplug.GetPropertyNames();

    for(int jj=0;jj<numOfProps;jj++)
      aNames[jj] = auxstrings[jj];
    // Convert all native property names into USMARC:

    for(int i=0;i<aNames.length;i++)

        aNames[i] = lusmarc.English2USMarc(aNames[i]);



    // Setting aState. Only aNames, the rest (anItemsState) after the loop.

    IDLInterchange.TItemsState aState =

                new IDLInterchange.TItemsState();

    aState.aNames = aNames;



    // Now we have set up all the common fields of the data structure.

    // aCookie and anITemsState are the only ones left.

    // aCookie is used to identify a document. This could be something

    // like the number (order) in the colplug's result table.

    // It's something that only the proxy understands.

    // anItemsState is the value of the requested fields for that doc.



    // So, as each document has a different cookie, we need to loop through

    // all of the the documents to be packed and set the values.



    // A 2-D array: Num of docs to pack X num of properties to get

    // for each document:

    CosPropertyService.Any[][] anItemsState =

                new CosPropertyService.Any [numDocs]

                                           [numOfProps];

    IDLInterchange.TAccessOption[][] aACs =

                new IDLInterchange.TAccessOption [numDocs][1];

    int i = colplug.DocCursor();

    String forcookies = "";

    CosPropertyService.Any aCookie =

                      new CosPropertyService.Any();

    while (i < numDocs ){

      // Setting aState.anItemsState. Get the props for the i'th doc:

      try {

        anItemsState[i] = GetPropertyValues(i,colplug);

      }

      catch (java.lang.ArrayIndexOutOfBoundsException e) {

        // Throw the same exception, but add the offending index

        // so that caller can make sense of it:

        throw new java.lang.ArrayIndexOutOfBoundsException(i);

      }



      // Constructing the cookie -> E'pointer':'number of doc'

      forcookies = "E";

      forcookies = forcookies.concat(String.valueOf(pointer));

      forcookies = forcookies.concat(":");

      forcookies = forcookies.concat(String.valueOf(i));



      // Putting the cookie and the rest in the right place

      aACs[i][0] = new IDLInterchange.TAccessOption();

      aACs[i][0].aTarget = this; // the proxy itself is the only able to

                               // respond to more the request_more_properties

      aACs[i][0].aCookie = new CosPropertyService.Any();

      aACs[i][0].aCookie.a_string(forcookies);

      System.out.println(aACs[i][0].aCookie.a_string());

      aACs[i][0].anItemClass = anItemClass; // not used

      aACs[i][0].aHints = aHints; // not used



      i++;

    }



    // Putting the values set in the loop in the right variable

    aState.anItemsState = anItemsState;

    IDLInterchange.TItemsACState pItems =

                new IDLInterchange.TItemsACState(aACs,aState);



    return pItems;

  }



  // GetPropertyValues

  // Returns the values of all the properties of the document pointed by

  // 'p' in the CollectionPlug pointed by colplug. The result is

  // and array of 'any's:



  private CosPropertyService.Any[] GetPropertyValues (int p,

                                                    CollectionPlug

						      colplug)

       throws java.lang.ArrayIndexOutOfBoundsException {



    int numOfProps = colplug.GetPropertyNames().length;

    CosPropertyService.Any[] aux =

                new CosPropertyService.Any [numOfProps];

    String[] values = new String[numOfProps];



    values = colplug.GetPropertyValues(p);



    for(int j=0;j<values.length;j++) {

        aux[j] = new CosPropertyService.Any();

        aux[j].a_string(values[j]);

    }



    return aux;

  }



  // GetPropertyValues

  // Returns the values of the properties in propname of the document pointed

  // by 'p' in the CollectionPlug pointed by colplug. Result is an

  // array of 'any':



  private CosPropertyService.Any[] GetPropertyValues (int p,

                      CollectionPlug colplug, String[] propnames)

      throws java.lang.ArrayIndexOutOfBoundsException,

             java.lang.IllegalArgumentException {

    CosPropertyService.Any[] aux =

                new CosPropertyService.Any [propnames.length];

    String[] values = new String[propnames.length];



    values = colplug.GetPropertyValues(p,

                lusmarc.USMarc2English(propnames));



    for(int j=0;j<values.length;j++) {

        aux[j] = new CosPropertyService.Any();

        aux[j].a_string(values[j]);

    }



    return aux;

  }



  // GetCollectionPlug

  // Returns a pointer in the colplugs array to the CollectionPlug

  // identified by the Cookie (cookies are of the form

  // Ex:y, where x is a pointer into the collection plug array,

  // and y is an index into the result array)



  private short GetCollectionPlug (CosPropertyService.Any Cookie) {

    short tablepos = 0;



    String stringcookie = Cookie.a_string();

    stringcookie = stringcookie.substring(1);

    int pos = stringcookie.indexOf(":");

    try {

      String aux = stringcookie.substring(0,pos);

      tablepos = Integer.valueOf(aux).shortValue();

    }

    catch (Exception e) {

        System.out.println(e);

    } 

    finally {

      return (tablepos);

    }

  }



  // GetDocPos

  // Returns the pointer to the document identify by the Cookie

  // Ex:y means: from the CollectionPlug 'x' in the colplugs array,

  // give the document 'y'



  private int GetDocPos (CosPropertyService.Any Cookie) {

    int numberofdoc = 0;



    String stringcookie = Cookie.a_string();

    stringcookie = stringcookie.substring(1);

    int pos = stringcookie.indexOf(":");

    try {

      String aux = stringcookie.substring(0,pos);

      short tablepos = Integer.valueOf(aux).shortValue();

      numberofdoc = Integer.valueOf(

            stringcookie.substring((pos +1),

            stringcookie.length())).shortValue();

    }

    catch (Exception e) {

        System.out.println(e);

    }

    finally {

        return (numberofdoc);

    }

  }



  // Init

  // Initializes the CollectionPlug array



  private void Init() {

        colplugspointer = 0;

        for(int i=0;i<colplugs.length;i++)

                colplugs[i] = new CollectionPlug();

  }



  // getNewCollectionPlug

  // Returns a pointer to the next free CollectionPlug available

  // in the colplugs array



  private short getNewCollectionPlug () {

        short aux = colplugspointer;

        if (colplugspointer == (MAX_COLPLUGS - 1)) {

                colplugspointer = 0;

        } else {

                colplugspointer++;

        }

        colplugs[aux] = new CollectionPlug();

        return aux;

  }



  // For compatibility with InfoBus, InfoBus clients expect USMarc

  // codes for property names. CollectionPlugs use normal name

  // such as 'title'

  private String[] ToUSMarc(String[] list) {



    USMarc usmarcxlator = new USMarc();

    String[] aux = new String[list.length];

    for(int i=0;i<list.length;i++)

      aux[i] = usmarcxlator.English2USMarc(list[i]);

    return aux;

  }



}