<!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: 0; mso-table-rspace: 0; background-color: #f5f5f5; border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0" bgcolor="#f5f5f5">
<!-- header here -->
<tbody>
<tr>
<td id="header-pattern-container" style="padding: 0; border-collapse: collapse; padding: 10px 20px">
<table id="header-pattern" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td id="header-avatar-image-container" valign="top" style="padding: 0; border-collapse: collapse; vertical-align: top; width: 32px; padding-right: 8px" width="32"> <img id="header-avatar-image" class="image_fix" src="https://avatar-cdn.atlassian.com/3673815784047b7e0673677a0bc7dde0?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F3673815784047b7e0673677a0bc7dde0%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue" height="32" width="32" border="0" style="border-radius: 3px; vertical-align: top"> </td>
<td id="header-text-container" valign="middle" style="padding: 0; 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="yrodiere" id="email_yrodiere" href="https://hibernate.atlassian.net/secure/ViewProfile.jspa?name=yrodiere" style="color:#6c797f;; color: #3b73af; text-decoration: none">Yoann Rodière</a> <strong>commented</strong> on <a href="https://hibernate.atlassian.net/browse/HSEARCH-2055" style="color: #3b73af; text-decoration: none"><img src="cid:jira-generated-image-avatar-4562c9de-f805-4adb-bd03-63fa3a07e32c" height="16" width="16" border="0" align="absmiddle" alt="Improvement"> HSEARCH-2055</a> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="email-content-container" style="padding: 0; 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: 0; mso-table-rspace: 0; 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: 0; 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: 0; 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: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td style="vertical-align: top;; padding: 0; 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-2055" style="color: #3b73af; text-decoration: none">Re: FieldBridge 2.0: generalize FieldBridge contract to deal with other backends</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: 0; 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: 0; mso-table-rspace: 0; 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: 0; border-collapse: collapse; padding: 0 0 10px"> <p style="margin: 10px 0 0; margin-top: 0">An update to first snippet, taking into account:</p>
<ul>
<li>the discussion (well, monologue) about encoding</li>
<li>the requirement to handles multiple input source</li>
<li>the custom bridge annotations mentioned in <span class="jira-issue-macro" data-jira-key="HSEARCH-175">
<!-- replace the span with an AUI template --> <a href="https://hibernate.atlassian.net/browse/HSEARCH-175" class="jira-issue-macro-key issue-link" title="Use domain specific annotations to plug custom bridges" style="color: #3b73af; text-decoration: none"> <img class="icon" src="https://hibernate.atlassian.net/secure/viewavatar?size=xsmall&avatarId=12151&avatarType=issuetype"> HSEARCH-175 </a> <span class="aui-lozenge aui-lozenge-subtle aui-lozenge-complete jira-macro-single-issue-export-pdf" style="background: #cccccc; border: 1px solid #cccccc; border-radius: 3px; color: #333333; display: inline-block; font-size: 11px; font-weight: bold; line-height: 99%; margin: 0; padding: 2px 5px; text-align: center; text-decoration: none; text-transform: uppercase; background-color: #ffffff; border-color: #cccccc; color: #333333" bgcolor="#ffffff">Open</span> </span> </li>
<li>the fact that we want to know from the start which entity properties will be accessed by custom field bridges; this will enable more complete dirtiness resolution ( <span class="jira-issue-macro" data-jira-key="HSEARCH-2496">
<!-- replace the span with an AUI template --> <a href="https://hibernate.atlassian.net/browse/HSEARCH-2496" class="jira-issue-macro-key issue-link" title="Smarter dirty checking when using @ContainedIn with custom field bridges" style="color: #3b73af; text-decoration: none"> <img class="icon" src="https://hibernate.atlassian.net/secure/viewavatar?size=xsmall&avatarId=12150&avatarType=issuetype"> HSEARCH-2496 </a> <span class="aui-lozenge aui-lozenge-subtle aui-lozenge-complete jira-macro-single-issue-export-pdf" style="background: #cccccc; border: 1px solid #cccccc; border-radius: 3px; color: #333333; display: inline-block; font-size: 11px; font-weight: bold; line-height: 99%; margin: 0; padding: 2px 5px; text-align: center; text-decoration: none; text-transform: uppercase; background-color: #ffffff; border-color: #cccccc; color: #333333" bgcolor="#ffffff">Open</span> </span> ), but also may help when using JSON as input (we'll be able to read the JSON as a stream, and only collect those values that are of interest to bridges)</li>
<li>the fact we want to give access to the SearchIntegrator from within bridges ( <span class="jira-issue-macro" data-jira-key="HSEARCH-1306">
<!-- replace the span with an AUI template --> <a href="https://hibernate.atlassian.net/browse/HSEARCH-1306" class="jira-issue-macro-key issue-link" title="Allow access to the SearchIntegrator from within a class bridge " style="color: #3b73af; text-decoration: none"> <img class="icon" src="https://hibernate.atlassian.net/secure/viewavatar?size=xsmall&avatarId=12150&avatarType=issuetype"> HSEARCH-1306 </a> <span class="aui-lozenge aui-lozenge-subtle aui-lozenge-complete jira-macro-single-issue-export-pdf" style="background: #cccccc; border: 1px solid #cccccc; border-radius: 3px; color: #333333; display: inline-block; font-size: 11px; font-weight: bold; line-height: 99%; margin: 0; padding: 2px 5px; text-align: center; text-decoration: none; text-transform: uppercase; background-color: #ffffff; border-color: #cccccc; color: #333333" bgcolor="#ffffff">Open</span> </span> )</li>
<li>and</li>
</ul> <p style="margin: 10px 0 0">This is all very rough at the moment, for instance it doesn't take into account that, potentially, the multiple input sources could be in contained objects (<tt>myObject.someProperty.someOtherProperty</tt>), so there will be some challenge in controlling the scope of annotation parsing.</p> <p style="margin: 10px 0 0">Annotation:</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; border-radius: 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
@BridgeDefinition(impl = MyBridge.class)
<span class="code-keyword" style="color: #000091">public</span> @<span class="code-keyword" style="color: #000091">interface</span> MyBridgeAnnotation {
<span class="code-object" style="color: #910091">String</span> foo();
@BridgeDefinition.Input <span class="code-comment" style="color: #808080">// Allows us to know which annotations to look <span class="code-keyword" style="color: #000091; color: #808080">for</span> when processing annotations
</span> @<span class="code-keyword" style="color: #000091">interface</span> SubInputAnnotation1 {
<span class="code-object" style="color: #910091">String</span> bar();
}
@BridgeDefinition.Input
@<span class="code-keyword" style="color: #000091">interface</span> SubInputAnnotation2 {
}
}
Bridge:
</pre>
</div>
</div> <p style="margin: 10px 0 0">public class MyBridge implements HibernateSearchComplexBridge<MyBridgeAnnotation> {<br> private Input<MyEntity, ?> defaultInput;<br> private Input<Date, SubInputAnnotation1> input1;<br> private Input<String, SubInputAnnotation2> input2;<br> private FieldDefinition<String> myField1;<br> private FieldDefinition<Date> myField2;<br> private FieldDefinition<Integer> myField3;</p> <p style="margin: 10px 0 0"> public void initialize(SearchIntegrator integrator /* <span class="jira-issue-macro" data-jira-key="HSEARCH-1306">
<!-- replace the span with an AUI template --> <a href="https://hibernate.atlassian.net/browse/HSEARCH-1306" class="jira-issue-macro-key issue-link" title="Allow access to the SearchIntegrator from within a class bridge " style="color: #3b73af; text-decoration: none"> <img class="icon" src="https://hibernate.atlassian.net/secure/viewavatar?size=xsmall&avatarId=12150&avatarType=issuetype"> HSEARCH-1306 </a> <span class="aui-lozenge aui-lozenge-subtle aui-lozenge-complete jira-macro-single-issue-export-pdf" style="background: #cccccc; border: 1px solid #cccccc; border-radius: 3px; color: #333333; display: inline-block; font-size: 11px; font-weight: bold; line-height: 99%; margin: 0; padding: 2px 5px; text-align: center; text-decoration: none; text-transform: uppercase; background-color: #ffffff; border-color: #cccccc; color: #333333" bgcolor="#ffffff">Open</span> </span> */) {</p> <p style="margin: 10px 0 0"> }</p> <p style="margin: 10px 0 0"> public void configure(MyBridgeAnnotation annotation, Metadata metadata)<br> String foo = annotation.foo();<br> // ... use foo to configure the bridge ...</p> <p style="margin: 10px 0 0"> // Allows bridges to use field names such as "<defaultName>.foo"<br> String defaultRelativeName = metadata.getDefaultRelativeName();</p> <p style="margin: 10px 0 0"> // Allows to bypass input registration (and thus disables automatic dirtiness detection)<br> /*</p>
<ul>
<li>Ideally, bridges using mutable input from different entities than the one the</li>
<li>annotation was applied to should not use this, and declare input explicitly</li>
<li>as is done for input1 and input2 below.<br> */<br> defaultInput = metadata.getDefaultInput( MyEntity.class );</li>
</ul> <p style="margin: 10px 0 0"> input1 = metadata.getInput( Date.class, SubInputAnnotation1.class );<br> input2 = metadata.getInput( String.class, SubInputAnnotation2.class );<br> SubInputAnnotation1 confInput1 = input1.get( SubInputAnnotation1.class );<br> // ... use confInput1.bar() to configure how input1 will be handled...</p> <p style="margin: 10px 0 0"> myField1 = metadata.addField("name1", MyEncodings.string().build() );<br> myField2 = metadata.addField("name2", MyEncodings.date().build() ).withImplementation( MyElasticsearchEncodings.date().withFormat( "yyy-mm-ddd" ).build() );<br> myField3 = metadata.addField("name3", MyEncodings.integer().build();<br> }</p> <p style="margin: 10px 0 0"> public void set(InputSource inputSource, org.hibernate.search.Document document) </p> { Date date = inputSource.get( input1 ); String string = inputSource.get( input2 ); // ... do some processing ... document.add(myField1, /* someValue */); document.add(myField2, /* someValue */); document.add(myField3, /* someValue */); } <p style="margin: 10px 0 0">}</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; border-radius: 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal">
Mapping:
</pre>
</div>
</div> <p style="margin: 10px 0 0">@MyBridgeAnnotation(foo = "foo")<br> public class MyEntity </p> { @MyBridgeAnnotation.SubInputAnnotation1 private String myProperty1; @MyBridgeAnnotation.SubInputAnnotation2 private String myProperty2; }
<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; border-radius: 3px; margin: 9px 0">
<div class="codeContent panelContent" style="padding: 9px 12px">
<pre class="code-java" style="margin: 10px 0 0; margin-top: 0; max-height: 30em; overflow: auto; white-space: pre-wrap; word-wrap: normal"></pre>
</div>
</div> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand " style="padding: 0; 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"> <script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "EmailMessage",
"description": "View Issue",
"potentialAction": {
"@type": "ViewAction",
"target": "https://hibernate.atlassian.net/browse/HSEARCH-2055?inbox=true&focusedCommentId=95919&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-95919",
"name": "View Comment"
},
"publisher": {
"@type": "Organization",
"name": "Atlassian",
"url": "https://www.atlassian.com"
}
}
</script>
<table id="actions-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0; 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: 0; border-collapse: collapse; padding: 10px 0 10px 24px; vertical-align: middle; padding-left: 0">
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td class="actions-pattern-action-icon-container" style="padding: 0; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 0; vertical-align: middle"> <a href="https://hibernate.atlassian.net/browse/HSEARCH-2055#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-e3820bc5-02ca-4ad2-bf68-8a85c274dcee" 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: 0; 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-2055#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: 0; 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: 0; border-collapse: collapse; padding: 12px 20px">
<table id="footer-pattern-container" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td id="footer-pattern-mobile-links" class="mobile-resize-text" width="100%" colspan="2" style="padding: 0; 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"> Get JIRA notifications on your phone! Download the JIRA Cloud app <a href="https://atlassian.app.link/EfJodxz7ZC" style="color: #3b73af; text-decoration: none">here</a>.
<hr style="height: 1px; color: #cccccc; background-color: #cccccc; border: none; margin-bottom: 12px" height="1" bgcolor="#cccccc"> </td>
</tr>
<tr>
<td id="footer-pattern-text" class="mobile-resize-text" width="100%" style="padding: 0; 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.1074.0#100051-<span title="d887ed3a0d82c13bf0ab6b1378555ccbffc658e2" data-commit-id="d887ed3a0d82c13bf0ab6b1378555ccbffc658e2}">sha1:d887ed3</span>)</span> </td>
<td id="footer-pattern-logo-desktop-container" valign="top" style="padding: 0; border-collapse: collapse; padding-left: 20px; vertical-align: top">
<table style="border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0">
<tbody>
<tr>
<td id="footer-pattern-logo-desktop-padding" style="padding: 0; border-collapse: collapse; padding-top: 3px"> <img id="footer-pattern-logo-desktop" src="cid:jira-generated-image-static-footer-desktop-logo-26e9fded-248f-49a8-bfc0-330c7a401628" 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>