@Relation: Entity class must be annotated with @Entity [74041772]

Fixed

Bug

Status Update

No update yet.

Description

am...@gmail.com

created issue #1

Mar 1, 2018 02:42AM

Component used: Room
Version used: 1.1.0-alpha2
Devices/Android versions reproduced on: compile error

Error:(8, 1) Gradle: error: Entity class must be annotated with @Entity
public class MetadataXmp2 {

I can't seem to implement @Relation. I simplified the entities I'm using to this:

@Entity(tableName = "meta")
public class MetadataEntity2 {
@PrimaryKey(autoGenerate = true)
public long id;
public float rating;
public String label;
}

public class MetadataXmp2 /* or extends MetadataEntity2 */ {
@Embedded
public MetadataEntity2 metadata;
@Relation(
parentColumn = "id",
entityColumn = "metaId",
projection = "subjectId",
entity = SubjectJunction.class)
public List<Long> subjectIds;

@Relation(
parentColumn = "id",
entityColumn = "id",
projection = "documentUri",
entity = FolderEntity.class)
public List<String> parentUris;
}

I have an extension of the original MetadataEntity that works fine without @Relation. Am I missing a limitation here?

Comments

yb...@google.com <yb...@google.com> #2Mar 1, 2018 07:45AM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit b90079595f33f58fece04026a97faa0d243acdb1
Author: Yuichi Araki <yaraki@google.com>
Date: Wed Sep 18 16:55:49 2019

Change the way to detect mismatch between POJO and query

This fixes cursor mismatch warnings with expandProjection.

Bug: 140759491
Test: QueryMethodProcessorTest
Change-Id: I7659002e5e0d1ef60fc1af2a625c0c36da0664d8

M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/QueryMethodProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/testing/TestProcessor.kt

https://android-review.googlesource.com/1123258

https://goto.google.com/android-sha1/b90079595f33f58fece04026a97faa0d243acdb1

am...@gmail.com <am...@gmail.com> #3Mar 1, 2018 02:34PM

The following changes were cherrypicked through Coastguard (

https://android-build.googleplex.com/coastguard/)
Release Track: (

https://android-build.googleplex.com/coastguard/dashboard/6093116828680192/#/cherrypickHistory/all)
Created: 2019-10-14 17:23:42.610596+00:00
Changes: aosp/1123258

yb...@google.com <yb...@google.com> #4Mar 1, 2018 04:42PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit bdde5a1a970ddc9007b28de4aa29d60ffa588f08
Author: Yigit Boyar <yboyar@google.com>
Date: Thu Apr 16 16:47:05 2020

Re-factor how errors are dismissed when query is re-written

This CL changes how we handle errors/warnings if query is
re-written.
There was a bug in expandProjection where we would report warnings
for things that Room already fixes automatically (

b/140759491

).
The solution to that problem (I7659002e5e0d1ef60fc1af2a625c0c36da0664d8)
solved it by deferring validating of columns until after re-write
decision is made. Unfortunately, this required changing PojoRowAdapter
to have a dummy mapping until it is validating, make it hard to use
as it does have a non-null mapping which is not useful.

This CL partially reverts that change and instead rely on the log
deferring logic we have in Context. This way, we don't need to break
the stability of PojoRowAdapter while still having the ability to
drop warnings that room fixes. This will also play nicer when we
have different query re-writing options that can use more information
about the query results.

Bug: 153387066
Bug: 140759491
Test: existing tests pass
Change-Id: I2ec967c763d33d7a3ff02c1a13c6953b460d1e5f

M room/compiler/src/main/kotlin/androidx/room/log/RLog.kt
M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt

https://android-review.googlesource.com/1288456

am...@gmail.com <am...@gmail.com> #5Mar 2, 2018 12:20AM

https://github.com/rcketscientist/roomRelationTest

I threw this together quickly, it does throw the error. I also gutted the Dao due to other dependencies, since this is a compilation error. If that's an issue let me know. If there are confusing combinations or java/kotlin I apologize as I was trying a lot of combinations just to ensure I wasn't bumping into a Kotlin bug.

yb...@google.com <yb...@google.com> #6Mar 5, 2018 07:47PM

Status: Won't Fix (Intended Behavior)

this is the problem in the code:
@RawQuery(observedEntities = [ MetadataXmp::class, FolderEntity::class, SubjectJunction::class ])
internal abstract fun internalGetRelationImages(query: SupportSQLiteQuery): LiveData<List<MetadataXmp>>

You are asking it to observe MetadataXmp but it is not an entity.

see the docs for details:

https://developer.android.com/reference/android/arch/persistence/room/RawQuery.html#observedEntities()

am...@gmail.com <am...@gmail.com> #7Mar 5, 2018 08:13PM

Ugh, that's a face-palm typo. Knew it had to be something like that. Thanks for taking the time to look at it.

Any chance that error could trace to the query instead of simply pointing at the non-entity we expect to be a non-entity?

[Location] references [Class] which must be annotated with @Entity

yb...@google.com <yb...@google.com> #8Mar 5, 2018 08:22PM

Assigned to yb...@google.com.

you are right, the error does not tell you the real problem.
I'll re-open the docs to improve the messaging.

yb...@google.com <yb...@google.com> #9Mar 13, 2018 06:29AM

Marked as fixed.

ok, I actually changed it to read Pojo's as well so your code will work. We'll traverse the Pojo and consider any @Relation / @Embedded as a table to watch.
If the pojo has no table references, we'll print a proper error.

am...@gmail.com <am...@gmail.com> #10Mar 13, 2018 11:06AM

Even better, thanks!