Package org.apache.cayenne.map
Class EmbeddedAttribute
java.lang.Object
org.apache.cayenne.map.Attribute
org.apache.cayenne.map.ObjAttribute
org.apache.cayenne.map.EmbeddedAttribute
- All Implemented Interfaces:
Serializable
,ConfigurationNode
,CayenneMapEntry
,XMLSerializable
An attribute of the ObjEntity that maps to an embeddable class.
- Since:
- 3.0
- See Also:
-
Field Summary
Fields inherited from class org.apache.cayenne.map.ObjAttribute
dbAttributePath, lazy, type, usedForLocking
-
Constructor Summary
ConstructorDescriptionEmbeddedAttribute
(String name) EmbeddedAttribute
(String name, String type, ObjEntity entity) Copying constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttributeOverride
(String name, String dbAttributeName) void
encodeAsXML
(XMLEncoder encoder, ConfigurationNodeVisitor delegate) Prints itself as XML to the provided XMLEncoder.getAttribute
(String name) Returns an ObjAttribute for a given name, taking into account column name overrides.getAttributeForDbPath
(String dbPath) Returns an ObjAttribute that maps to a givenDbAttribute
, or returns null if no such attribute exists.Returns a Collection of ObjAttributes of an embedded object taking into account column name overrides.Class
<?> Returns Java class of an object property described by this attribute.getType()
Returns a type of this attribute that must be anEmbeddable
object.void
void
Sets a type of this attribute that must be anEmbeddable
object.Methods inherited from class org.apache.cayenne.map.ObjAttribute
acceptVisitor, getClientAttribute, getDbAttribute, getDbAttributeName, getDbAttributePath, getDbPathIterator, getDbPathIterator, getEntity, getMaxLength, isFlattened, isInherited, isLazy, isMandatory, isPrimaryKey, isUsedForLocking, setDbAttributePath, setLazy, setUsedForLocking, toString, updateDbAttributePath
-
Field Details
-
attributeOverrides
-
-
Constructor Details
-
EmbeddedAttribute
public EmbeddedAttribute() -
EmbeddedAttribute
-
EmbeddedAttribute
-
EmbeddedAttribute
Copying constructor- Parameters:
other
- attribute to copy- Since:
- 4.2
-
-
Method Details
-
encodeAsXML
Description copied from class:ObjAttribute
Prints itself as XML to the provided XMLEncoder.- Specified by:
encodeAsXML
in interfaceXMLSerializable
- Overrides:
encodeAsXML
in classObjAttribute
-
getAttributeOverrides
-
getEmbeddable
-
getAttributeForDbPath
Returns an ObjAttribute that maps to a givenDbAttribute
, or returns null if no such attribute exists. -
getAttribute
Returns an ObjAttribute for a given name, taking into account column name overrides. -
getAttributes
Returns a Collection of ObjAttributes of an embedded object taking into account column name overrides. -
addAttributeOverride
-
removeAttributeOverride
-
getType
Returns a type of this attribute that must be anEmbeddable
object.- Overrides:
getType
in classObjAttribute
-
getJavaClass
Returns Java class of an object property described by this attribute. Wraps any thrown exceptions into CayenneRuntimeException.- Overrides:
getJavaClass
in classObjAttribute
-
setType
Sets a type of this attribute that must be anEmbeddable
object.- Overrides:
setType
in classObjAttribute
-