Contact数据模型之EntityDelta

public class EntityDelta implements Parcelable

EntityDelta的数据模型描述：

EntityDelta 是 ValuesDelta 的集合，它还实现了Parcelable接口。它包含了主数据(存在ValuesDelta mValues中）和子数据.它把子数据以 ValuesDelta的形式按照它们的 mimetype存放在 HashMap<String, ArrayList<ValuesDelta>> mEntries中(拥有相同的mimetype的ValuesDelta放在同一个ArrayList).

注1： EntityDelta可用于RawContact。主数据正好对应RawContact的主表，子数据正好对应RawContact的子表。

关于RawContact的更多内容参照《RawContacts 》

注2：ValuesDelta是EntityDelta的一个内部类。更多关于ValuesDelta的，可以参考《Contact数据模型之ValuesDelta 》

构造函数

publicEntityDelta()

创建一个空的EntityDelta

publicEntityDelta(ValuesDelta values)

创建一个EntityDelta，并用ValuesDelta values来初始化主数据。

主要成员变量：

private ValuesDeltamValues;

用于存放 主表（主数据），

private HashMap<String, ArrayList<ValuesDelta>>mEntries= Maps.newHashMap();

用于存放 子表（子数据），子数据以ValuesDelta的形式按照它们的mimetype存放在其中。

静态成员变量

public static final Parcelable.Creator<EntityDelta>CREATOR

注：该变量因Parcelable而设计。

主要静态函数：

public static EntityDeltafromBefore(Entity before)

用Entity before来实例化一个EntityDelta,把Entity before的 getEntityValues( )得到主数据以ValuesDelta.fromBefore的形式打包成ValuesDelta并赋予 mValues .且设置mValues的mIdColumn为RawContacts._ID。然后用before.getSubValues()得到子数据,然后以ValuesDelta.fromBefore的形式打包成 ValuesDelta 并放入 mEntries 。

注1：这里的Entity before对应一个RawContacts的数据。

注2：该函数在把Entity转化成EntityDelta的过程中，把Entity的子数据的 Uri uri丢失了。

因为对于update操作可以通过ValuesDelta的id就可以确定它的位置（当然Uri uri也可以确定，然而Data.CONTENT_URI是固定,所以可以丢弃 Uri uri）。

对于删除操作，有主数据的信息就可以了。

public static EntityDeltamergeAfter(EntityDelta local, EntityDelta remote)

用 EntityDelta remote 对 EntityDelta local 进行mergeAfter操作。它主要是通过对EntityDelta local和EntityDelta remote中的ValuesDelta进行相应的ValuesDelta的mergeAfter操作来实现mergeAfter操作。对于主数据是直接对他们进行mergeAfter操作。对于子数据，是对同id(即ValuesDelta的mIdColumn值相同)的ValuesDelta进行mergeAfter操作。最后返回新的EntityDelta local。

注1：EntityDelta local可以为null,这时会创建一个空的EntityDelta以便处理。

注2：mergeAfter操作是针对EntityDelta local而进行，所以它会被改变。

注3：关于ValuesDelta的mergeAfter操作的更多内容可参考《Contact数据模型之ValuesDelta 》

主要成员函数：

public ValuesDeltagetValues()

返回主数据mValues。

public booleanisContactInsert()

返回是否是Insert操作，通过调用主数据mValues的isInsert()方法来判断。

public ValuesDeltagetPrimaryEntry(String mimeType)

从子表集合变量 mEntries， 返回PrimaryEntry

得到MIME类型为mimeType的PrimaryEntry。找到MIME类型为mimeType的ValuesDelta且它的isPrimary()为true，就返回该ValuesDelta。

如果没找到，但 MIME 类型为mimeType的ValuesDelta的ArrayList<ValuesDelta>至少有一个，则返回该列表上的第一个ValuesDelta。否则返回null。

public ValuesDeltagetSuperPrimaryEntry(String mimeType)

从子表集合变量 mEntries，返回SuperPrimaryEntry

它直接调用getSuperPrimaryEntry(mimeType, true)。

public ValuesDeltagetSuperPrimaryEntry(String mimeType, boolean forceSelection)

从子表集合变量 mEntries，返回SuperPrimaryEntry

原理和getPrimaryEntry(String mimeType)相似。但是只有forceSelection为true的情况下，才在没有找到SuperPrimaryEntry的情况下返回PrimaryEntry，如果PrimaryEntry也没找到，才返回MIME类型为mimeType的ValuesDelta的ArrayList<ValuesDelta>的第一的ValuesDelta，如果ArrayList<ValuesDelta>为空则返回null。

private ArrayList<ValuesDelta>getMimeEntries(String mimeType, boolean lazyCreate)

从子表集合变量 mEntries，得到指定MIME类型mimeType的ArrayList<ValuesDelta>，如果lazyCreate为true，在IME类型mimeType的ArrayList<ValuesDelta>没被创建的情况下，会创建它并放入HashMap<String, ArrayList<ValuesDelta>> mEntrie中。

public ArrayList<ValuesDelta>getMimeEntries(String mimeType)

直接调用getMimeEntries(mimeType, false)。

public intgetMimeEntriesCount(String mimeType, boolean onlyVisible)

从子表集合变量 mEntries，得到指定MIME类型mimeType的ValuesDelta数量。如果onlyVisible是true,则ValuesDelta还必须是isVisible()的。

public booleanhasMimeEntries(String mimeType)

返回HashMap<String, ArrayList<ValuesDelta>>中是否有MIME类型mimeType的ArrayList<ValuesDelta>。

public ValuesDeltaaddEntry(ValuesDelta entry)

向子表集合变量 mEntries加入一个ValuesDelta entry。

public ValuesDeltagetEntry(Long childId)

从子表集合变量 mEntries返回id为Long childId的ValuesDelta

public intgetEntryCount(boolean onlyVisible)

得到子表集合变量 mEntries中ValuesDelta的数量，如果onlyVisible是true,则ValuesDelta还必须是isVisible()的。

public booleanequals(Object object)

返回两个EntityDelta是否相当。只有他们所包括的ValuesDelta一样才相等。（这里包括主数据ValuesDelta mValues和子数据HashMap<String, ArrayList<ValuesDelta>>）

注：这里的"一样"是指ValuesDelta的equals(Object object)返回true.

private booleancontainsEntry(ValuesDelta entry)

用于检测ValuesDelta entry是否已经在子表集合变量 mEntries 中。

public voidmarkDeleted()

对包含的所有ValuesDelta进行markDeleted()操作。（这里包括主数据ValuesDelta mValues和子数据HashMap<String, ArrayList<ValuesDelta>>）

public StringtoString()

把所有ValuesDelta进行转化为String.

private voidpossibleAdd(ArrayList<ContentProviderOperation> diff,ContentProviderOperation.Builder builder)

在builder不为空的情况下，把builder生成的ContentProviderOperation加入到ArrayList<ContentProviderOperation> diff中。

注1：该方法其实应该是static的才对。不知道为什么google没把它写成静态的。也许是google的失误吧。

public voidbuildAssert(ArrayList<ContentProviderOperation> buildInto)

/**

* Build a list of {@link ContentProviderOperation} that will assert any

* "before" state hasn't changed. This is maintained separately so that all

* asserts can take place before any updates occur.

*/

用主数据mValues的 Id和 RawContacts.VERSION生产一个 RawContacts.CONTENT_URI上的AssertQuery形builder，并加入ArrayList<ContentProviderOperation> buildInto)。

注：该函数的真正意义应该是在对数据库操作时（Provide中）进行数据库更新时 确保数据的一致性。即数据在我们读到EntityDelta并没有改变过。

public voidbuildDiff(ArrayList<ContentProviderOperation> buildInto)

该函数负责把该EntityDelta转化为ArrayList<ContentProviderOperation>,以便进行数据库操作。它主要是调用ValuesDelta的buildDiff来进行ContentProviderOperation，然后把他们整合起来。

注1：对于全新的插入操作，需要在操作前把主表mValues的 RawContacts.AGGREGATION_MODE设置为 RawContacts.AGGREGATION_MODE_SUSPENDED，等子数据都插入完了才设置为 RawContacts.AGGREGATION_MODE_DEFAULT。

注2：对于更新操作，但是子数据有插入操作的同上。

注3：如果主数据时插入操作，那么子数据也必须是插入操作，否则会抛异常。

注4：对于全EntityDelta的删除操作，只需要主表的信息就可以了，因为它的每个子表都存有主表的Id(即Data.RAW_CONTACT_ID).

注5：创建AssertQuery形的builder，可用这样的形式： final ContentProviderOperation.Builder builder = ContentProviderOperation.newAssertQuery(RawContacts.CONTENT_URI)

protected BuilderbuildSetAggregationMode(Long beforeId, int mode)

用Long beforeId, int mode生成update的Builder。

public intdescribeContents()

返回0.// Nothing special about this parcel

注：该方法来自Parcelable。

public voidwriteToParcel(Parcel dest, int flags)

把主表和子表数据都写到Parcel。

注：该方法来自Parcelable。

public voidreadFromParcel(Parcel source)

从Parcel source中读取主表和子表数据。