Android Open Source - lightbox-android-webservices Save Operation

From Project

Back to project page lightbox-android-webservices.

License

The source code is released under:

Apache License

If you think the Android project lightbox-android-webservices listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

/**
 * Copyright (c) 2012 Lightbox/* w  w w  .j a va2 s .co  m*/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.lightbox.android.operations;

import java.util.List;

import com.lightbox.android.utils.debug.DebugLog;
import com.lightbox.android.webservices.requests.ApiRequest;
import com.lightbox.android.webservices.responses.ApiResponse;

/** 
 * SaveOperation 
 * @author Fabien Devos
 */
public class SaveOperation<T> extends AbstractOperation<T> {
  /** Used to tag logs */
  //@SuppressWarnings("unused")
  private static final String TAG = "SaveOperation";
  
  private T mData;
  
  //----------------------------------------------
  // Constructor
  
  /**
   * Constructor.
   * @param data the data to save
   * @param dataClass the class of the data
   * @param apiRequest the API request object to use for saving
   */
  public SaveOperation(T data, Class<T> dataClass, ApiRequest apiRequest) {
    super(dataClass, apiRequest);
    mData = data;
  }

  //----------------------------------------------
  // Getter
  
  public T getData() {
    return mData;
  }

  //----------------------------------------------
  // Operation

  @Override
  public List<T> executeLocalOperationSync() throws Exception {
    getDao().createOrUpdate(mData);
    return wrapInList(mData);
  }
  
  public List<T> executeServerOperationSync() throws Exception {
    // Try to update on the server
    ApiResponse<?> apiResponse = getApiRequest().execute();
    
    Object result = apiResponse.getContent();

    // Save data coming from the server
    saveDataComingFromServer(unwrapList(result));
  
    return wrapInList(result);
  }
  
  @Override
  public final List<T> executeSync() throws Exception {
    // Save data in the database
    mData = unwrapList(executeLocalOperationSync());
    
    // Try to save on the server
    try {
      mData = unwrapList(executeServerOperationSync());       
    } catch (Exception e) {
      DebugLog.d(TAG, "Failed to save data on the server: %s", e);
      
      // We must wait for the next synchronization
    }

    // Return the (possibly merged and saved) object
    return wrapInList(mData);
  }
  
  private void saveDataComingFromServer(T data) throws Exception {
    if(data != null) {
      // Hook
      onSaveDataComingFromServer(data);
      
      if (data instanceof Retrievable) {
        // Since this comes from the server, we can set the retrieved time to now
        ((Retrievable) data).setRetrievedTime(System.currentTimeMillis());
      }
      if (data instanceof Updatable) {
        // We can now mark all fields as NOT locally updated
        ((Updatable) data).clearLocallyUpdatedFieldsMarks();
      }
      
      // Save the merged object in the database
      getDao().createOrUpdate(data);
    }
  }  
  
  //----------------------------------------------
  // Hooks for subclasses

  protected void onSaveDataComingFromServer(T data) throws Exception {
    // Nothing by default
  }
  
}

Java Source Code List