Android:deserialize KSoap2 response into Complex object or arrays purely

Little Carl

Rate me:

4.86/5 (5 votes)

21 Aug 2014CPOL2 min read

33.8K

987

Library for deserializing the Ksoap2 response .

Download Deserialization.java.zip - 1.9 KB

Introduction

This project is aimed to help you deserialize KSoap2 response into complex object (Class in your project) and ArrayList by using my class file.

Background

KSoap2 is really a good library for us to use web service on android devices.However,I found it hard to parse or deserialize the result into my own class objects or arrays like(ArrayList<E>).I write the library to do all of this for deserializing the response.

You can receive the result like

Java

MyClass myClassObect=new MyClass(SoapObject response);//response is the result from Web service

Using the code

Download and add the java file into your own Package and then alter the packge name of your own!!!

Inside the java file is a class called 'Deserialization' ,it has only one generic method called 'SoapDeserialize' which is used to deserialize the response.Signaniture is defined below:

C++

// the first parameter item is the variable of your class T
//The second parameter object is the Soap context(named by me :-)) which is actually an instance of SoapObject.
public  <T> void SoapDeserialize(T item,SoapObject object){
//TODO...
}

Say we have a class Person.

Java

public class Person{
String name;
int age;
ArrayList<Person> children;//include other person's info

}

The response(toString) from webservice may look like this:

AnyType={name=Iron Man,age=30,children=AnyType{AnyType={name=IronDaughter....},AnyType={name=IronSon....}... }}

Such a complex structure,huh?

What we need to do is just adding a constructor for our class Person.

Java

public class Person{
String name;
int age;
ArrayList<Person> children;//include other person's info
public Person(SoapObject object){
new Deserialization().SoapDeserialize(this,object);

//'this' is the instance itself ,
//object is the SoapObject received from response when we call new Person(soapobject)

}
}

What we need to do is just to hand the job to Deserialization class and it will do it for us.

Java

ht.call("yourURL", yourEnvelop);//call the web service
          if (yourEnvelop.getResponse()!=null) {      
                //if receive only one object
                Person person=new Person((SoapObject)envelope.getResponse());
               //receive array of objects,directly call SoapDeserialize()
               // the first parameter is the Class of the objects in array the second parameter is soapObject ,the same as above
               // This method return an array which is the result we need 
                 ArrayList<Person> arrayList=new ArrayList<Person>();
                arrayList= new Deserialization().SoapDeserialize(Person.class,(SoapObject)(envelope.getResponse()));
               
          }

From my test ,all types below can be identified and dealed by my class.

int,Integer
Double
String
Float
Complex Class (As long as you declare the constructor I mention before)
ArrayList<T> (Which should work for ArrayList raw type ,too.Haven't tested for Vector type)
I haven't added Enum type,but if you want,it's easy if you understand the code inside my file.

Remember:Every complex Object class always should declare the constructor for being dealed by the deserialization tool.Moreover,don‘t forget the declaration in class T of ArrayList<T> because you may not directly call this to instance this,but this is called from the deserialization tool.

How I make it work:

Use reflect to get your class's fields and determine which type it belong to by Field.getType method.

For ArrayList,I do it in the same way but dynamicaly instantiate the variable for every object in SoapObject like

AnyType={name=Iron Man,age=30,children=AnyType{AnyType={name=IronDaughter....},AnyType={name=IronSon....}... }}

and add them to a list(Arraylist variable) ,this process is actually a recursion. Then use Field.set(person,list) to set list to the actual field.

Feel free to download my code and alter it as you want.

If you have any problem ,just feel free to let me know .

Thanks.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Written By

Little Carl

Software Developer (Senior) Gudu

China

I enjoy WPF programing and Node.js development.I'm living in Shanghai,China.

public class DRListItems { private String DR_ID; private String DR_Name; private String DR_Subject; private String DR_Details; private String DR_DateOfMessage; private String DR_FK_PatientID; private String DR_FK_DRegID; public DRListItems() { } public DRListItems(SoapObject object) { new Deserilization().SoapDeserilize(this,object); } public String getDR_ID() { return DR_ID; } public void setDR_ID(String DR_ID) { this.DR_ID = DR_ID; } public String getDR_Name() { return DR_Name; } public void setDR_Name(String DR_Name) { this.DR_Name = DR_Name; } public String getDR_Subject() { return DR_Subject; } public void setDR_Subject(String DR_Subject) { this.DR_Subject = DR_Subject; } public String getDR_Details() { return DR_Details; } public void setDR_Details(String DR_Details) { this.DR_Details = DR_Details; } public String getDR_DateOfMessage() { return DR_DateOfMessage; } public void setDR_DateOfMessage(String DR_DateOfMessage) { this.DR_DateOfMessage = DR_DateOfMessage; } public String getDR_FK_PatientID() { return DR_FK_PatientID; } public void setDR_FK_PatientID(String DR_FK_PatientID) { this.DR_FK_PatientID = DR_FK_PatientID; } public String getDR_FK_DRegID() { return DR_FK_DRegID; } public void setDR_FK_DRegID(String DR_FK_DRegID) { this.DR_FK_DRegID = DR_FK_DRegID; } }

private static String NAMESPACE = "http://tempuri.org/"; private static String URL = "http://something.com/service.asmx"; private static String SOAP_ACTION = "http://tempuri.org/"; public static ArrayList<DRListItems> GetDrMessages(String PatientID , String WebMethodName) { ArrayList<DRListItems> arr = null; SoapObject request = new SoapObject(NAMESPACE,WebMethodName); PropertyInfo info = new PropertyInfo(); info.setName("PatientID"); info.setValue(PatientID); info.setType(String.class); request.addProperty(info); SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11); envelope.dotNet = true; envelope.setOutputSoapObject(request); HttpTransportSE androidHTTP = new HttpTransportSE(URL); try { androidHTTP.call(SOAP_ACTION+WebMethodName , envelope); // DRListItems items = new DRListItems((SoapObject)envelope.getResponse()); arr = new ArrayList<DRListItems>(); arr = new Deserilization().SoapDeserializeArray(DRListItems.class,(SoapObject)envelope.getResponse()); } catch (Exception e) { e.printStackTrace(); } return arr; }

private class AsyncCallGetMessages extends AsyncTask<String, Void, Void> { @Override protected Void doInBackground(String... params) { MessagesFromServer = FarahWebService.GetDrMessages(GettingPatID,"GetDrMessages"); return null; } @Override protected void onPostExecute(Void result) { pbDRMessages.setVisibility(View.INVISIBLE); } @Override protected void onPreExecute() { pbDRMessages.setVisibility(View.VISIBLE); } @Override protected void onProgressUpdate(Void... values) { } }

private void setListData() { for(int i=0;i<MessagesFromServer.size();i++) { final DRListItems li = new DRListItems(); li.setDR_Name("Dr. Ahmad al-qarem"); li.setDR_DateOfMessage("7/12/2014 10:10 A.M " + i); li.setDR_Subject("Subject : " + "there is nothing " + i); customlistvaluesarr.add(li); } }

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Android:deserialize KSoap2 response into Complex object or arrays purely

Introduction

Background

Using the code

How I make it work:

License

Comments and Discussions