NHibernate.Mapping.Attributes

Attribute taking an order position.

Initializes a new instance of the class.

This constructor is only called by classes that derive from . The position at which the attribute has been declared.

Compares the current instance with another object of the same type.

The position at which the attribute has been declared.

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if Insert has been specified.

Tells if Update has been specified.

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if OptimisticLock has been specified.

Use this attribute to give a value to a field identified in a mapping attribute.

Default constructor

Gets or sets the name used to identify the field (without the quotes).

Gets or sets the value of the identified field.

Gets or sets the 'format' used by System.Enum.Format() in ValueObject.

Default constructor (position=0)

Constructor taking the position of the attribute.

Enable the lazy loading of this collection

Tells if Lazy has been specified.

Tells if Inverse has been specified.

Tells if OptimisticLock has been specified.

The concrete collection should use a generic version or an object-based version.

Tells if Generic has been specified.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default value (don't use it)

read-only

read-write

nonstrict-read-write

Rule as to how to operate on child objects (for more information, read topics about "persistence by reachability" or "transparent/transitive/cascading persistence")

Default value (don't use it)

all

all-delete-orphan

none

save-update

delete

delete-orphan

Root of an entity class hierarchy. Entities have their own tables

Default constructor (position=0)

Constructor taking the position of the attribute.

default: no proxy interface

Enable the lazy loading of this class in associations

Tells if Lazy has been specified.

Tells if DynamicUpdate has been specified.

Tells if DynamicInsert has been specified.

Tells if SelectBeforeUpdate has been specified.

default: unqualified classname

default: no value

default: unqualified class name | none

'format' used by System.Enum.Format() in DiscriminatorValueObject

Tells if Mutable has been specified.

default: none

Default value (don't use it)

select

join

subselect

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if NotNull has been specified.

Tells if Unique has been specified.

Map properties of a child object to columns of the table of a parent class

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if Update has been specified.

Tells if Insert has been specified.

Use this attribute to define a "component" on a property/field.

Default constructor

Gets or sets the type of the component.

Gets or sets the name of the property which has the type of the component.

Default constructor (position=0)

Constructor taking the position of the attribute.

A composite key may be modelled by a .NET class with a property for each key column. The class must be Serializable and override equals() and hashCode()

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default value (don't use it)

none

rowcount

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Polymorphic data requires a column holding a class discriminator value. This value is not directly exposed to the application

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if NotNull has been specified.

Tells if Force has been specified.

Tells if Insert has been specified.

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if Update has been specified.

Tells if Insert has been specified.

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if NotNull has been specified.

Tells if Unique has been specified.

Default value (don't use it)

select

join

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Default value (don't use it)

auto

never

Tells which algorithm to use to generate the identifier

Default constructor (position=0)

Constructor taking the position of the attribute.

Build hbm.xml files from entities (Class, Subclass or JoinedSubclass).

Writes a hbm.xml file in the specified directory for each mapped class in the specified assembly.

Directory where each serialized hbm.xml file will be written. Assembly used to extract user-defined types containing a valid attribute (can be [Class], [Subclass] or [JoinedSubclass]).

Writes the mapping of all mapped classes of the specified assembly in the specified hbm.xml file.

Assembly used to extract user-defined types containing a valid attribute (can be [Class], [Subclass] or [JoinedSubclass]). Where the xml is written.

Writes the mapping of all mapped classes of the specified assembly in the specified stream.

Where the xml is written. Assembly used to extract user-defined types containing a valid attribute (can be [Class], [Subclass] or [JoinedSubclass]).

Writes the mapping of all mapped classes of the specified assembly in a MemoryStream and returns it.

Assembly used to extract user-defined types containing a valid attribute (can be [Class], [Subclass] or [JoinedSubclass]). Stream containing the XML mapping.

Writes the mapping of the specified class in a MemoryStream and returns it.

User-defined type containing a valid attribute (can be [Class], [Subclass] or [JoinedSubclass]). Stream containing the XML mapping.

Writes the mapping of the specified class in the specified hbm.xml file.

Where the xml is written. User-defined type containing a valid attribute (can be [Class], [Subclass] or [JoinedSubclass]).

Writes the mapping of the specified class in the specified stream.

Where the xml is written. User-defined type containing a valid attribute (can be [Class], [Subclass] or [JoinedSubclass]).

Writes the mapping of the specified class in the specified stream.

Where the xml is written; can be null if you send the writer. User-defined type containing a valid attribute (can be [Class], [Subclass] or [JoinedSubclass]). The XmlTextWriter used to write the xml; can be null if you send the stream. You can also create it yourself, but don't forget to write the StartElement ("hibernate-mapping") before. Tells if the EndElement of "hibernate-mapping" must be written; send false to append many classes in the same stream. The parameter writer if it was not null; else it is a new writer (created using the stream). Send it back to append many classes in this stream.

Gets a static instance of HbmSerializer (if you don't want/need to create an instance).

Gets or sets the HbmWriter to use.

Gets or sets whether generated xml files must be validated against NHibernate mapping schema.

Gets or sets whether generated xml files will contain a comment with the date/time of the generation.

Gets errors that occur while serializing.

Gets or sets this "hibernate-mapping" attribute

Gets or sets if this "hibernate-mapping" attribute is specified

Write a XmlSchemaElement from attributes in a System.Type.

Searches the members of the class for any member with the attribute defined.

Return all (BaseAttribute derived) attributes in the MethodDeclaration sorted using their position.

Tells if 'element1' come after 'element2' in rootType's 'sub-elements' order.

Gets the xml enum value from the associated attributed enum.

Returns the value received or uses it as an identifier to find its value in a AttributeIdentifierAttribute in the mapped class.

Write user-defined content; should be of the specified contentAttributeType.

Write a Filter XML Element from attributes in a member.

Write a SqlInsert XML Element from attributes in a member.

Write a SqlUpdate XML Element from attributes in a member.

Write a SqlDelete XML Element from attributes in a member.

Write a SqlDeleteAll XML Element from attributes in a member.

Write a Loader XML Element from attributes in a member.

Write a ResultSet XML Element from attributes in a member.

Write a HibernateMapping XML Element from attributes in a type.

Write HibernateMapping XML Elements from nested mapped classes in a not-mapped class.

Write a FilterParam XML Element from attributes in a member.

Write a FilterDef XML Element from attributes in a member.

Write a Create XML Element from attributes in a member.

Write a Drop XML Element from attributes in a member.

Write a DialectScope XML Element from attributes in a member.

Write a Definition XML Element from attributes in a member.

Write a DatabaseObject XML Element from attributes in a member.

Write a Import XML Element from attributes in a type.

Write Import XML Elements from nested mapped classes in a not-mapped class.

Write a Class XML Element from attributes in a type.

Write Class XML Elements from nested mapped classes in a not-mapped class.

Write a Id XML Element from attributes in a member.

Write a CompositeId XML Element from attributes in a member.

Write a Discriminator XML Element from attributes in a member.

Write a Version XML Element from attributes in a member.

Write a Timestamp XML Element from attributes in a member.

Write a Subclass XML Element from attributes in a type.

Write Subclass XML Elements from nested mapped classes in a not-mapped class.

Write a JoinedSubclass XML Element from attributes in a type.

Write JoinedSubclass XML Elements from nested mapped classes in a not-mapped class.

Write a Join XML Element from attributes in a member.

Write a Property XML Element from attributes in a member.

Write a MetaValue XML Element from attributes in a member.

Write a Any XML Element from attributes in a member.

Write a Array XML Element from attributes in a member.

Write a Cache XML Element from attributes in a member.

Write a CollectionId XML Element from attributes in a member.

Write a Column XML Element from attributes in a member.

Write a Component XML Element from attributes in a type.

Write Component XML Elements from nested mapped classes in a not-mapped class.

Write a DynamicComponent XML Element from attributes in a member.

Write a CompositeElement XML Element from attributes in a member.

Write a CompositeIndex XML Element from attributes in a member.

Write a Element XML Element from attributes in a member.

Write a Generator XML Element from attributes in a member.

Write a IdBag XML Element from attributes in a member.

Write a Index XML Element from attributes in a member.

Write a IndexManyToAny XML Element from attributes in a member.

Write a IndexManyToMany XML Element from attributes in a member.

Write a JcsCache XML Element from attributes in a member.

Write a Key XML Element from attributes in a member.

Write a KeyManyToOne XML Element from attributes in a member.

Write a KeyProperty XML Element from attributes in a member.

Write a ManyToAny XML Element from attributes in a member.

Write a ManyToMany XML Element from attributes in a member.

Write a ManyToOne XML Element from attributes in a member.

Write a Meta XML Element from attributes in a member.

Write a NestedCompositeElement XML Element from attributes in a member.

Write a OneToMany XML Element from attributes in a member.

Write a OneToOne XML Element from attributes in a member.

Write a Param XML Element from attributes in a member.

Write a Parent XML Element from attributes in a member.

Write a PrimitiveArray XML Element from attributes in a member.

Write a Query XML Element from attributes in a member.

Write a Return XML Element from attributes in a member.

Write a ReturnDiscriminator XML Element from attributes in a member.

Write a ReturnScalar XML Element from attributes in a member.

Write a ReturnColumn XML Element from attributes in a member.

Write a ReturnProperty XML Element from attributes in a member.

Write a ReturnJoin XML Element from attributes in a member.

Write a LoadCollection XML Element from attributes in a member.

Write a Synchronize XML Element from attributes in a member.

Write a SqlQuery XML Element from attributes in a member.

Write a List XML Element from attributes in a member.

Write a Bag XML Element from attributes in a member.

Write a Set XML Element from attributes in a member.

Write a Map XML Element from attributes in a member.

Write a Type XML Element from attributes in a member.

Gets or sets the HbmWriterHelper used by HbmWriter

Gets or sets the beginning string used when declaring an identifier for an AttributeIdenfierAttribute

Gets or sets the ending string used when declaring an identifier for an AttributeIdenfierAttribute

Gets or sets the Patterns to convert properties types (the key is the pattern string and the value is the replacement string)

Customized HbmWriter. Support ComponentPropertyAttribute.

Return the value to use when a (required) attribute is not specified. Note: Implementations of Get_XXX_YYY_DefaultValue() return [type|property].Name; // YYY is the "identifier" of XXX ThrowRequiredValueNotProvidedException(); // There is no way to get it

Customized HbmWriterHelper. Support ComponentPropertyAttribute.

Value returned by overridden methods.

hibernate-mapping is the document root

Default constructor (position=0)

Constructor taking the position of the attribute.

defaults to none used

Default property access setting

Tells if AutoImport has been specified.

Namespace used to find not-Fully Qualified Type Names

Assembly used to find not-Fully Qualified Type Names

Default value of the lazy attribute for persistent classes and collections

Tells if DefaultLazy has been specified.

Declares the id type, column and generation algorithm for an entity class. If a name attribute is given, the id is exposed to the application through the named property of the class. If not, the id is only exposed to the application via Session.getIdentifier()

Default constructor (position=0)

Constructor taking the position of the attribute.

any|none|null|0|-1|...

Default constructor (position=0)

Constructor taking the position of the attribute.

Enable the lazy loading of this collection

Tells if Lazy has been specified.

Tells if Inverse has been specified.

Tells if OptimisticLock has been specified.

The concrete collection should use a generic version or an object-based version.

Tells if Generic has been specified.

An explicit query language "import"

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default value (don't use it)

read-only

read-write

nonstrict-read-write

Default constructor (position=0)

Constructor taking the position of the attribute.

default: no value

Tells if Inverse has been specified.

Tells if Optional has been specified.

Joined subclasses are used for the normalized table-per-subclass mapping strategy

Default constructor (position=0)

Constructor taking the position of the attribute.

default: no proxy interface

Enable the lazy loading of this class in associations

Tells if Lazy has been specified.

Tells if DynamicUpdate has been specified.

Tells if DynamicInsert has been specified.

Tells if SelectBeforeUpdate has been specified.

Name of the root class. Required if the Joined Subclass is declared outside the declaration of its root class

default: unqualified classname

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default value (don't use it)

false

proxy

Default constructor (position=0)

Constructor taking the position of the attribute.

Enable the lazy loading of this collection

Tells if Lazy has been specified.

Tells if Inverse has been specified.

Tells if OptimisticLock has been specified.

The concrete collection should use a generic version or an object-based version.

Tells if Generic has been specified.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default value (don't use it)

none

read

upgrade

upgrade-nowait

write

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if NotNull has been specified.

Tells if Unique has been specified.

Tells if Update has been specified.

Tells if Insert has been specified.

Default constructor (position=0)

Constructor taking the position of the attribute.

Enable the lazy loading of this collection

Tells if Lazy has been specified.

Tells if Inverse has been specified.

Tells if OptimisticLock has been specified.

The concrete collection should use a generic version or an object-based version.

Tells if Generic has been specified.

Exception occuring when NHibernate.Mapping.Attributes finds an error in your mapping (using its .NET attributes). Most of the time, the error is due to an omission of a required type/name in the mapping.

Initializes a new instance of the class.

The message that describes the error.

Initializes a new instance of the class.

The message that describes the error. The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

Initializes a new instance of the class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if Inherit has been specified.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default value (don't use it)

ignore

exception

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if Constrained has been specified.

Default value (don't use it)

none

version

dirty

all

Default value (don't use it)

auto

true

false

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Types of polymorphism

Default value (don't use it)

implicit

explicit

Default constructor (position=0)

Constructor taking the position of the attribute.

Property of an entity class or component, component-element, composite-id, etc. Class Properties (get_ and set_ methods) are mapped to table columns

Default constructor (position=0)

Constructor taking the position of the attribute.

Tells if NotNull has been specified.

Tells if Unique has been specified.

only supported for properties of a class (not component)

Tells if Update has been specified.

only supported for properties of a class (not component)

Tells if Insert has been specified.

only supported for properties of a class (not component)

Tells if OptimisticLock has been specified.

only supported for properties of a class (not component)

Default value (don't use it)

never

insert

always

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Use this attribute to add any XML at a specific place.

Default constructor

Gets or sets the type of XML elements after which this XML will be added (omit to put on top).

Gets or sets the XML content.

Default value (don't use it)

false

proxy

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Default constructor (position=0)

Constructor taking the position of the attribute.

Enable the lazy loading of this collection

Tells if Lazy has been specified.

Tells if Inverse has been specified.

Tells if OptimisticLock has been specified.

The concrete collection should use a generic version or an object-based version.

Tells if Generic has been specified.

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Default constructor (position=0)

Constructor taking the position of the attribute.

Gets or sets the content of this element

Subclass declarations are nested beneath the root class declaration to achieve polymorphic persistence

Default constructor (position=0)

Constructor taking the position of the attribute.

default: no proxy interface

Enable the lazy loading of this class in associations

Tells if Lazy has been specified.

Tells if DynamicUpdate has been specified.

Tells if DynamicInsert has been specified.

Tells if SelectBeforeUpdate has been specified.

Name of the root class. Required if the Subclass is declared outside the declaration of its root class

default: unqualified class name | none

'format' used by System.Enum.Format() in DiscriminatorValueObject

Default constructor (position=0)

Constructor taking the position of the attribute.

Is equivalent to <version type="timestamp">

Default constructor (position=0)

Constructor taking the position of the attribute.

undefined|any|none|null|0|-1|...

Default constructor (position=0)

Constructor taking the position of the attribute.

Values used to restrict composite-id, does not apply to meta/column/generator

Default value (don't use it)

any

none

Versioned data requires a column holding a version number. This is exposed to the application through a property of the .NET class

Default constructor (position=0)

Constructor taking the position of the attribute.

undefined|any|none|null|0|-1|...

Default value (don't use it)

never

always