| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>AttributeOverride</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AttributeOverride"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/persistence/AttributeNode.html" title="interface in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/persistence/AttributeOverrides.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/persistence/AttributeOverride.html" target="_top">Frames</a></li> |
| <li><a href="AttributeOverride.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.persistence</div> |
| <h2 title="Annotation Type AttributeOverride" class="title">Annotation Type AttributeOverride</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Repeatable(value=<a href="../../jakarta/persistence/AttributeOverrides.html" title="annotation in jakarta.persistence">AttributeOverrides.class</a>) |
| @Target(value={TYPE,METHOD,FIELD}) |
| @Retention(value=RUNTIME) |
| public @interface <span class="memberNameLabel">AttributeOverride</span></pre> |
| <div class="block">Used to override the mapping of a <code>Basic</code> (whether |
| explicit or default) property or field or <code>Id</code> property or |
| field. |
| |
| <p> May be applied to an entity that extends a mapped superclass or |
| to an embedded field or property to override a basic mapping or id |
| mapping defined by the mapped superclass or embeddable class (or |
| embeddable class of one of its attributes). |
| |
| <p> May be applied to an element collection containing instances of |
| an embeddable class or to a map collection whose key and/or value |
| is an embeddable class. When <code>AttributeOverride</code> is |
| applied to a map, "<code>key.</code>" or "<code>value.</code>" must |
| be used to prefix the name of the attribute that is being |
| overridden in order to specify it as part of the map key or map |
| value. |
| |
| <p> To override mappings at multiple levels of embedding, a dot (".") |
| notation form must be used in the <code>name</code> element to indicate an |
| attribute within an embedded attribute. The value of each identifier |
| used with the dot notation is the name of the respective embedded |
| field or property. |
| |
| <p> If <code>AttributeOverride</code> is not specified, the column |
| is mapped the same as in the original mapping. |
| |
| <pre> |
| Example 1: |
| |
| @MappedSuperclass |
| public class Employee { |
| @Id protected Integer id; |
| @Version protected Integer version; |
| protected String address; |
| public Integer getId() { ... } |
| public void setId(Integer id) { ... } |
| public String getAddress() { ... } |
| public void setAddress(String address) { ... } |
| } |
| |
| @Entity |
| @AttributeOverride(name="address", column=@Column(name="ADDR")) |
| public class PartTimeEmployee extends Employee { |
| // address field mapping overridden to ADDR |
| protected Float wage(); |
| public Float getHourlyWage() { ... } |
| public void setHourlyWage(Float wage) { ... } |
| } |
| |
| |
| Example 2: |
| |
| @Embeddable public class Address { |
| protected String street; |
| protected String city; |
| protected String state; |
| @Embedded protected Zipcode zipcode; |
| } |
| |
| @Embeddable public class Zipcode { |
| protected String zip; |
| protected String plusFour; |
| } |
| |
| @Entity public class Customer { |
| @Id protected Integer id; |
| protected String name; |
| @AttributeOverrides({ |
| @AttributeOverride(name="state", |
| column=@Column(name="ADDR_STATE")), |
| @AttributeOverride(name="zipcode.zip", |
| column=@Column(name="ADDR_ZIP")) |
| }) |
| @Embedded protected Address address; |
| ... |
| } |
| |
| |
| Example 3: |
| |
| @Entity public class PropertyRecord { |
| @EmbeddedId PropertyOwner owner; |
| @AttributeOverrides({ |
| @AttributeOverride(name="key.street", |
| column=@Column(name="STREET_NAME")), |
| @AttributeOverride(name="value.size", |
| column=@Column(name="SQUARE_FEET")), |
| @AttributeOverride(name="value.tax", |
| column=@Column(name="ASSESSMENT")) |
| }) |
| @ElementCollection |
| Map<Address, PropertyInfo> parcels; |
| } |
| |
| @Embeddable public class PropertyInfo { |
| Integer parcelNumber; |
| Integer size; |
| BigDecimal tax; |
| } |
| |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../jakarta/persistence/Embedded.html" title="annotation in jakarta.persistence"><code>Embedded</code></a>, |
| <a href="../../jakarta/persistence/Embeddable.html" title="annotation in jakarta.persistence"><code>Embeddable</code></a>, |
| <a href="../../jakarta/persistence/MappedSuperclass.html" title="annotation in jakarta.persistence"><code>MappedSuperclass</code></a>, |
| <a href="../../jakarta/persistence/AssociationOverride.html" title="annotation in jakarta.persistence"><code>AssociationOverride</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.required.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Required Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> |
| <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Required Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/persistence/Column.html" title="annotation in jakarta.persistence">Column</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/AttributeOverride.html#column--">column</a></span></code> |
| <div class="block">(Required) The column that is being mapped to the persistent |
| attribute.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/AttributeOverride.html#name--">name</a></span></code> |
| <div class="block">(Required) The name of the property whose mapping is being |
| overridden if property-based access is being used, or the |
| name of the field if field-based access is used.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="name--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public abstract java.lang.String name</pre> |
| <div class="block">(Required) The name of the property whose mapping is being |
| overridden if property-based access is being used, or the |
| name of the field if field-based access is used.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="column--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>column</h4> |
| <pre>public abstract <a href="../../jakarta/persistence/Column.html" title="annotation in jakarta.persistence">Column</a> column</pre> |
| <div class="block">(Required) The column that is being mapped to the persistent |
| attribute. The mapping type will remain the same as is |
| defined in the embeddable class or mapped superclass.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/persistence/AttributeNode.html" title="interface in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/persistence/AttributeOverrides.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/persistence/AttributeOverride.html" target="_top">Frames</a></li> |
| <li><a href="AttributeOverride.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
