com.orientechnologies.orient.core.db.record.ORecordLazyMap Maven / Gradle / Ivy

/*
  *
  *  *  Copyright 2014 Orient Technologies LTD (info(at)orientechnologies.com)
  *  *
  *  *  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.
  *  *
  *  * For more information: http://www.orientechnologies.com
  *
  */
package com.orientechnologies.orient.core.db.record;

import java.util.Collection;
import java.util.Iterator;
import java.util.Map;

import com.orientechnologies.orient.core.db.ODatabaseRecordThreadLocal;
import com.orientechnologies.orient.core.db.record.ORecordMultiValueHelper.MULTIVALUE_CONTENT_TYPE;
import com.orientechnologies.orient.core.exception.ORecordNotFoundException;
import com.orientechnologies.orient.core.id.ORID;
import com.orientechnologies.orient.core.record.ORecord;
import com.orientechnologies.orient.core.record.impl.ODocument;

/**
 * Lazy implementation of LinkedHashMap. It's bound to a source ORecord object to keep track of changes. This avoid to call the
 * makeDirty() by hand when the map is changed.
 * 
 * @author Luca Garulli (l.garulli--at--orientechnologies.com)
 * 
 */
@SuppressWarnings({ "serial" })
public class ORecordLazyMap extends OTrackedMap implements ORecordLazyMultiValue {
  final private byte                                      recordType;
  private ORecordMultiValueHelper.MULTIVALUE_CONTENT_TYPE status              = MULTIVALUE_CONTENT_TYPE.EMPTY;
  protected boolean                                       marshalling         = false;
  private boolean                                         autoConvertToRecord = true;

  public ORecordLazyMap(final ODocument iSourceRecord) {
    super(iSourceRecord);
    this.recordType = ODocument.RECORD_TYPE;
  }

  public ORecordLazyMap(final ODocument iSourceRecord, final byte iRecordType) {
    super(iSourceRecord);
    this.recordType = iRecordType;

    if (iSourceRecord != null) {
      if (!iSourceRecord.isLazyLoad())
        // SET AS NON-LAZY LOAD THE COLLECTION TOO
        autoConvertToRecord = false;
    }
  }

  public ORecordLazyMap(final ODocument iSourceRecord, final Map iOrigin) {
    this(iSourceRecord);
    if (iOrigin != null && !iOrigin.isEmpty())
      putAll(iOrigin);
  }

  @Override
  public boolean containsValue(final Object o) {
    return super.containsValue(o);
  }

  @Override
  public OIdentifiable get(final Object iKey) {
    if (iKey == null)
      return null;

    final String key = iKey.toString();

    if (autoConvertToRecord)
      convertLink2Record(key);

    return super.get(key);
  }

  @Override
  public OIdentifiable put(final Object key, OIdentifiable value) {
    if (status == MULTIVALUE_CONTENT_TYPE.ALL_RIDS && value instanceof ORecord && !value.getIdentity().isNew())
      // IT'S BETTER TO LEAVE ALL RIDS AND EXTRACT ONLY THIS ONE
      value = value.getIdentity();
    else
      status = ORecordMultiValueHelper.updateContentType(status, value);

    return super.put(key, value);
  }

  @Override
  public Collection values() {
    convertLinks2Records();
    return super.values();
  }

  @Override
  public OIdentifiable remove(Object o) {
    final OIdentifiable result = super.remove(o);
    if (size() == 0)
      status = MULTIVALUE_CONTENT_TYPE.EMPTY;
    return result;
  }

  @Override
  public void clear() {
    super.clear();
    status = MULTIVALUE_CONTENT_TYPE.EMPTY;
  }

  @Override
  public String toString() {
    return ORecordMultiValueHelper.toString(this);
  }

  public boolean isAutoConvertToRecord() {
    return autoConvertToRecord;
  }

  public void setAutoConvertToRecord(boolean convertToRecord) {
    this.autoConvertToRecord = convertToRecord;
  }

  public void convertLinks2Records() {
    if (status == MULTIVALUE_CONTENT_TYPE.ALL_RECORDS || !autoConvertToRecord
        || getOwner().getInternalStatus() == STATUS.MARSHALLING)
      // PRECONDITIONS
      return;
    for (Object k : keySet())
      convertLink2Record(k);

    status = MULTIVALUE_CONTENT_TYPE.ALL_RECORDS;
  }

  public boolean convertRecords2Links() {
    if (status == MULTIVALUE_CONTENT_TYPE.ALL_RIDS)
      // PRECONDITIONS
      return true;

    boolean allConverted = true;
    for (Object k : keySet())
      if (!convertRecord2Link(k))
        allConverted = false;

    if (allConverted)
      status = MULTIVALUE_CONTENT_TYPE.ALL_RIDS;

    return allConverted;
  }

  private boolean convertRecord2Link(final Object iKey) {
    if (status == MULTIVALUE_CONTENT_TYPE.ALL_RIDS)
      return true;

    final Object value = super.get(iKey);
    if (value != null)
      if (value instanceof ORecord && !((ORecord) value).getIdentity().isNew()) {
        if (((ORecord) value).isDirty())
          ODatabaseRecordThreadLocal.INSTANCE.get().save((ORecord) value);

        marshalling = true;
        try {
          // OVERWRITE
          super.put(iKey, ((ORecord) value).getIdentity());
        } finally {
          marshalling = false;
        }

        // CONVERTED
        return true;
      } else if (value instanceof ORID)
        // ALREADY CONVERTED
        return true;

    return false;
  }

  /**
   * Convert the item with the received key to a record.
   * 
   * @param iKey
   *          Key of the item to convert
   */
  private void convertLink2Record(final Object iKey) {
    if (status == MULTIVALUE_CONTENT_TYPE.ALL_RECORDS)
      return;

    final Object value;

    if (iKey instanceof ORID)
      value = iKey;
    else
      value = super.get(iKey);

    if (value != null && value instanceof ORID) {
      final ORID rid = (ORID) value;
      marshalling = true;
      try {
        try {
          // OVERWRITE IT
          super.put(iKey, rid.getRecord());
        } catch (ORecordNotFoundException e) {
          // IGNORE THIS
        }
      } finally {
        marshalling = false;
      }
    }
  }

  @Override
  public OTrackedMap setDirty() {
    if (!marshalling)
      return super.setDirty();

    return this;
  }

  @Override
  public void setDirtyNoChanged() {
    if (!marshalling)
      super.setDirtyNoChanged();
  }

  @Override
  protected void fireCollectionChangedEvent(final OMultiValueChangeEvent event) {
    if (!marshalling)
      super.fireCollectionChangedEvent(event);
  }

  public byte getRecordType() {
    return recordType;
  }

  public Iterator rawIterator() {
    return new OLazyRecordIterator(sourceRecord, super.values().iterator(), false);
  }

  public boolean detach() {
    return convertRecords2Links();
  }

  @Override
  public int size() {
    return super.size();
  }
}