<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
<base href="https://hibernate.atlassian.net">
<title>Message Title</title>
</head>
<body class="jira" style="color: #333333; font-family: Arial, sans-serif; font-size: 14px; line-height: 1.429">
<table id="background-table" cellpadding="0" cellspacing="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5; border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt" bgcolor="#f5f5f5">
<!-- header here -->
<tbody>
<tr>
<td id="header-pattern-container" style="padding: 0px; border-collapse: collapse; padding: 10px 20px">
<table id="header-pattern" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="header-avatar-image-container" valign="top" style="padding: 0px; border-collapse: collapse; vertical-align: top; width: 32px; padding-right: 8px" width="32"> <img id="header-avatar-image" class="image_fix" src="cid:jira-generated-image-avatar-44a0088e-6435-4f03-ac1f-097e87407b5a" height="32" width="32" border="0" style="border-radius: 3px; vertical-align: top"> </td>
<td id="header-text-container" valign="middle" style="padding: 0px; border-collapse: collapse; vertical-align: middle; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px"> <a class="user-hover" rel="fenrhil" id="email_fenrhil" href="https://hibernate.atlassian.net/secure/ViewProfile.jspa?name=fenrhil" style="color:#6c797f;; color: #3b73af; text-decoration: none">Yoann Rodière</a> <strong>commented</strong> on <a href="https://hibernate.atlassian.net/browse/HSEARCH-2267" style="color: #3b73af; text-decoration: none"><img src="cid:jira-generated-image-avatar-56e033bf-4540-4279-93b4-49ff7aaf60d3" height="16" width="16" border="0" align="absmiddle" alt="New Feature"> HSEARCH-2267</a> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="email-content-container" style="padding: 0px; border-collapse: collapse; padding: 0 20px">
<table id="email-content-table" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-spacing: 0; border-collapse: separate">
<tbody>
<tr>
<!-- there needs to be content in the cell for it to render in some clients -->
<td class="email-content-rounded-top mobile-expand" style="padding: 0px; border-collapse: collapse; color: #ffffff; padding: 0 15px 0 16px; height: 15px; background-color: #ffffff; border-left: 1px solid #cccccc; border-top: 1px solid #cccccc; border-right: 1px solid #cccccc; border-bottom: 0; border-top-right-radius: 5px; border-top-left-radius: 5px; height: 10px; line-height: 10px; padding: 0 15px 0 16px; mso-line-height-rule: exactly" height="10" bgcolor="#ffffff"> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand " style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff" bgcolor="#ffffff">
<table class="page-title-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td style="vertical-align: top;; padding: 0px; border-collapse: collapse; padding-right: 5px; font-size: 20px; line-height: 30px; mso-line-height-rule: exactly" class="page-title-pattern-header-container"> <span class="page-title-pattern-header" style="font-family: Arial, sans-serif; padding: 0; font-size: 20px; line-height: 30px; mso-text-raise: 2px; mso-line-height-rule: exactly; vertical-align: middle"> <a href="https://hibernate.atlassian.net/browse/HSEARCH-2267" style="color: #3b73af; text-decoration: none">Re: Marker annotation for fields whose dirtiness is irrelevant to HSearch</a> </span> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="text-paragraph-pattern-top" class="email-content-main mobile-expand comment-top-pattern" style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff; border-bottom: none; padding-bottom: 0" bgcolor="#ffffff">
<table class="text-paragraph-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 2px">
<tbody>
<tr>
<td class="text-paragraph-pattern-container mobile-resize-text " style="padding: 0px; border-collapse: collapse; padding: 0 0 10px 0">
<blockquote style="margin: 10px 0 0 0; margin-top: 0; border-left: 1px solid #cccccc; color: #707070; margin-left: 19px; padding: 10px 20px">
<p style="margin: 10px 0 0 0; margin-top: 0">To clarify: this only applies to an entity which is using a ClassBridge right?<br> For fields of an entity which is not using such a bridge, I would expect the indexing engine to be able to figure out that a specific entity property is not going to be read, without even needing an annotation. Wondering if we can avoid the additional annotation and still do the right thing.</p>
</blockquote> <p style="margin: 10px 0 0 0">In our case, it's more about transient (computed) fields than about <tt>ClassBridge</tt> s. But yes, for {{ClassBridge} s the problem would be the same.</p> <p style="margin: 10px 0 0 0">To clarify, the use case is the following:</p>
<div class="code panel" style="border-width: 1px;; border: 1px solid #cccccc; background: #f5f5f5; font-size: 12px; line-height: 1.333; font-family: monospace; border: 1px solid #cccccc; -moz-border-radius: 3px 3px 3px 3px; border-radius: 3px 3px 3px 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
@Indexed
@Entity
<span class="code-keyword" style="color: #000091">public</span> class MyClass {
@Id
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">Long</span> id;
@Basic
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field1UsedInTransientIndex;
@Basic
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field2UsedInTransientIndex;
@Basic
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field3NOTUsedInTransientIndex;
<span class="code-comment" style="color: #808080">// ... getters and setters, with no @Field on them ...
</span>
@Transient
@Field
<span class="code-keyword" style="color: #000091">public</span> <span class="code-object" style="color: #910091">int</span> getComputedValue() {
<span class="code-keyword" style="color: #000091">return</span> doSomeComplexCalculation(field1UsedInTransientIndex, field2UsedInTransientIndex);
}
}
</pre>
</div>
</div> <p style="margin: 10px 0 0 0">In this case, Hibernate Search cannot know (without additional metadata) what entity property the method <tt>getComputedValue</tt> depend on. Which is, as you said, quite different from knowing which index fields are affected by this method. Currently, it means that whenever Hibernate Search detects an <tt>@Transient @Field</tt>, it disables dirty-checking completely.</p> <p style="margin: 10px 0 0 0">One solution, proposed in <a href="https://hibernate.atlassian.net/browse/HSEARCH-1093" class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none">https://hibernate.atlassian.net/browse/HSEARCH-1093</a>, would be to add an annotation to declare which entity properties this method rely on:</p>
<div class="code panel" style="border-width: 1px;; border: 1px solid #cccccc; background: #f5f5f5; font-size: 12px; line-height: 1.333; font-family: monospace; border: 1px solid #cccccc; -moz-border-radius: 3px 3px 3px 3px; border-radius: 3px 3px 3px 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
@Basic
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field1UsedInTransientIndex;
@Basic
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field2UsedInTransientIndex;
@Basic
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field3NOTUsedInTransientIndex;
<span class="code-comment" style="color: #808080">// ... getters and setters, with no @Field on them ...
</span>
@AssociateDirty(fields={<span class="code-quote" style="color: #009100">"field1UsedInTransientIndex"</span>, <span class="code-quote" style="color: #009100">"field2UsedInTransientIndex"</span>}) <span class="code-comment" style="color: #808080">// <==== HERE
</span> @Transient
@Field
<span class="code-keyword" style="color: #000091">public</span> <span class="code-object" style="color: #910091">int</span> getComputedValue() {
<span class="code-keyword" style="color: #000091">return</span> doSomeComplexCalculation(field1UsedInTransientIndex, field2UsedInTransientIndex);
}
</pre>
</div>
</div> <p style="margin: 10px 0 0 0">That way, Hibernate Search would consider that whenever "field1UsedInTransientIndex" or "field2UsedInTransientIndex" are dirty, then the "computedValue" field needs reindexing.</p> <p style="margin: 10px 0 0 0">This seems like a valid solution, but:</p> <p style="margin: 10px 0 0 0"> 1. Nobody seems to have time to implement it right now (judging by the last update on the JIRA ticket)<br> 2. This would not solve the issue for <tt>ClassBridge</tt> s (unless we allow adding this annotation on a <tt>ClassBridge</tt> 's class?)</p> <p style="margin: 10px 0 0 0">The other solution, proposed in this ticket, would be to add an annotation to declare which entity properties <b>no field</b> (i.e. no <tt>@Transient @Field</tt> method, no <tt>ClassBridge</tt>) depend on:</p>
<div class="code panel" style="border-width: 1px;; border: 1px solid #cccccc; background: #f5f5f5; font-size: 12px; line-height: 1.333; font-family: monospace; border: 1px solid #cccccc; -moz-border-radius: 3px 3px 3px 3px; border-radius: 3px 3px 3px 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
@Basic
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field1UsedInTransientIndex;
@Basic
<span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field2UsedInTransientIndex;
@Basic
@IndexTransient <span class="code-comment" style="color: #808080">// <==== HERE
</span> <span class="code-keyword" style="color: #000091">private</span> <span class="code-object" style="color: #910091">String</span> field3NOTUsedInTransientIndex;
<span class="code-comment" style="color: #808080">// ... getters and setters, with no @Field on them ...
</span>
@Transient
@Field
<span class="code-keyword" style="color: #000091">public</span> <span class="code-object" style="color: #910091">int</span> getComputedValue() {
<span class="code-keyword" style="color: #000091">return</span> doSomeComplexCalculation(field1UsedInTransientIndex, field2UsedInTransientIndex);
}
</pre>
</div>
</div> <p style="margin: 10px 0 0 0">That way, we could implement a preliminary check in the <tt>FullTextIndexEventListener</tt> whenever a Hibernate update occurs: if all of the dirty properties are annotated <tt>@IndexTransient</tt>, then skip re-indexing.<br> This second solution would provide a way to positively identify entity properties that are not used when indexing. Currently either we are sure they are used (annotated @Field) or we don't know (no annotation). With this annotation, we'd have a third category, where we <b>know</b> the property is not used when indexing.<br> I think this second solution really is relevant even if the first is ultimately implemented: if I've got 3 properties and 10 <tt>@Transient @Field</tt> methods, I'd rather just annotate one property with <tt>@IndexTransient</tt> than annotate my 10 methods with <tt>@AssociateDirty</tt>...</p> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand " style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff" bgcolor="#ffffff">
<table id="actions-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px">
<tbody>
<tr>
<td id="actions-pattern-container" valign="middle" style="padding: 0px; border-collapse: collapse; padding: 10px 0 10px 24px; vertical-align: middle; padding-left: 0">
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 0px; vertical-align: middle"> <a href="https://hibernate.atlassian.net/browse/HSEARCH-2267#add-comment" target="_blank" title="Add Comment" style="color: #3b73af; text-decoration: none"> <img class="actions-pattern-action-icon-image" src="cid:jira-generated-image-static-comment-icon-b7c5ff8f-a8d4-43e6-98a2-63627d22cafb" alt="Add Comment" title="Add Comment" height="16" width="16" border="0" style="vertical-align: middle"> </a> </td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 4px; padding-left: 5px"> <a href="https://hibernate.atlassian.net/browse/HSEARCH-2267#add-comment" target="_blank" title="Add Comment" style="color: #3b73af; text-decoration: none">Add Comment</a> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table> </td>
</tr>
<!-- there needs to be content in the cell for it to render in some clients -->
<tr>
<td class="email-content-rounded-bottom mobile-expand" style="padding: 0px; border-collapse: collapse; color: #ffffff; padding: 0 15px 0 16px; height: 5px; line-height: 5px; background-color: #ffffff; border-top: 0; border-left: 1px solid #cccccc; border-bottom: 1px solid #cccccc; border-right: 1px solid #cccccc; border-bottom-right-radius: 5px; border-bottom-left-radius: 5px; mso-line-height-rule: exactly" height="5" bgcolor="#ffffff"> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="footer-pattern" style="padding: 0px; border-collapse: collapse; padding: 12px 20px">
<table id="footer-pattern-container" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="footer-pattern-text" class="mobile-resize-text" width="100%" style="padding: 0px; border-collapse: collapse; color: #999999; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule: exactly; mso-text-raise: 2px"> This message was sent by Atlassian JIRA <span id="footer-build-information">(v1000.5.2#72002-<span title="b4422fef7d0b71281abfaa8a6ba825b85c07a2bf" data-commit-id="b4422fef7d0b71281abfaa8a6ba825b85c07a2bf}">sha1:b4422fe</span>)</span> </td>
<td id="footer-pattern-logo-desktop-container" valign="top" style="padding: 0px; border-collapse: collapse; padding-left: 20px; vertical-align: top">
<table style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="footer-pattern-logo-desktop-padding" style="padding: 0px; border-collapse: collapse; padding-top: 3px"> <img id="footer-pattern-logo-desktop" src="cid:jira-generated-image-static-footer-desktop-logo-9c79ea30-cf36-4c2c-bec4-959d280381c4" alt="Atlassian logo" title="Atlassian logo" width="169" height="36" class="image_fix"> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table>
</body>
</html>