+ MyInvocationHandler interceptor = ...
+ ProxyGenerator generator = new ProxyGenerator();
+ IInterfaceExposed proxy =
+ generator.CreateProxy( new Type[] { typeof(IInterfaceExposed) }, interceptor );
+
+ You can use any object that implements the
To make a
It is also standard practice that at least one of your constructors takes an
A collection that contains no duplicate elements. This class models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
A collection that contains no duplicate elements. This interface models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
A collection that contains no duplicate elements. This interface models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
Implements an immutable (read-only)
Although this is advertised as immutable, it really isn't. Anyone with access to the
+
Implements a thread-safe
You can use any object that implements the
To make a
It is also standard practice that at least one of your constructors takes an
Implements an immutable (read-only)
Although this is advertised as immutable, it really isn't. Anyone with access to the
+
+ configuration.Configure("path/to/hibernate.cfg.xml");
+
+
+ If this ConnectionProvider is being Finalized (
+ If any subclasses manage resources that also need to be disposed of this method + should be overridden, but don't forget to call it in the override. +
+concat(?1, ?2) to concatenate two strings
+ p1 and p2. Target SQL function will be dialect-specific, e.g. (?1 || ?2) for
+ Oracle, concat(?1, ?2) for MySql, (?1 + ?2) for MS SQL.
+ Each dialect will define a template as a string (exactly like above) marking function
+ parameters with '?' followed by parameter's index (first index is 1).
+
+ This method checks the string
+ After the OpenQuote and CloseQuote have been cleaned from the string
+ The following quoted values return these results + "quoted" = quoted + "quote""d" = quote"d + quote""d = quote"d +
++ If this implementation is not sufficient for your Dialect then it needs to be overridden. + MsSql2000Dialect is an example of where UnQuoting rules are different. +
+
+ This method assumes that the name is not already Quoted. So if the name passed
+ in is
+ If the aliasName is already enclosed in the OpenQuote and CloseQuote then this + method will return the aliasName that was passed in without going through any + Quoting process. So if aliasName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the columnName is already enclosed in the OpenQuote and CloseQuote then this + method will return the columnName that was passed in without going through any + Quoting process. So if columnName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the tableName is already enclosed in the OpenQuote and CloseQuote then this + method will return the tableName that was passed in without going through any + Quoting process. So if tableName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the schemaName is already enclosed in the OpenQuote and CloseQuote then this + method will return the schemaName that was passed in without going through any + Quoting process. So if schemaName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
+
+
+ SELECT TOP last (columns) FROM (
+ SELECT ROW_NUMBER() OVER(ORDER BY __hibernate_sort_expr_1__ {sort direction 1} [, __hibernate_sort_expr_2__ {sort direction 2}, ...]) as row, (query.columns) FROM (
+ {original select query part}, {sort field 1} as __hibernate_sort_expr_1__ [, {sort field 2} as __hibernate_sort_expr_2__, ...]
+ {remainder of original query minus the order by clause}
+ ) query
+ ) page WHERE page.row > offset
+
+
+
+ Note that we need to add explicitly specify the columns, because we need to be able to use them
+ in a paged subselect. NH-1155
+ + Author: Ioan Bizau +
++ This dialect probably will not work with schema-export. If anyone out there + can fill in the ctor with DbTypes to Strings that would be helpful. +
+ The SybaseDialect defaults the following configuration properties: ++ This dialect probably will not work with schema-export. If anyone out there + can fill in the ctor with DbTypes to Strings that would be helpful. +
+ The SybaseAnywhereDialect defaults the following configuration properties: +
+ Names.Put(DbType, "TEXT" );
+ Names.Put(DbType, 255, "VARCHAR($1)" );
+ Names.Put(DbType, 65534, "LONGVARCHAR($1)" );
+
+ will give you back the following:
+
+ Names.Get(DbType) // --> "TEXT" (default)
+ Names.Get(DbType,100) // --> "VARCHAR(100)" (100 is in [0:255])
+ Names.Get(DbType,1000) // --> "LONGVARCHAR(1000)" (100 is in [256:65534])
+ Names.Get(DbType,100000) // --> "TEXT" (default)
+
+ On the other hand, simply putting
+
+ Names.Put(DbType, "VARCHAR($1)" );
+
+ would result in
+
+ Names.Get(DbType) // --> "VARCHAR($1)" (will cause trouble)
+ Names.Get(DbType,100) // --> "VARCHAR(100)"
+ Names.Get(DbType,1000) // --> "VARCHAR(1000)"
+ Names.Get(DbType,10000) // --> "VARCHAR(10000)"
+
+
+ key="hibernate.connection.driver_class"
+ value="FullyQualifiedClassName, AssemblyName"
+
+ IDbParameter param = cmd.Parameters["@paramName"]
+ if this is false the code will be
+ IDbParameter param = cmd.Parameters["paramName"].
+ + Author: Oliver Weichhold +
++ In order to use this Driver you must have the Npgsql.dll Assembly available for + NHibernate to load it. +
++ Please check the products website + http://www.postgresql.org/ + for any updates and or documentation. +
++ The homepage for the .NET DataProvider is: + http://gborg.postgresql.org/project/npgsql/projdisplay.php. +
++ In order to use this driver you must have the System.Data.SQLite.dll assembly available + for NHibernate to load. This assembly includes the SQLite.dll or SQLite3.dll libraries. +
++ You can get the System.Data.SQLite.dll assembly from http://sourceforge.net/projects/sqlite-dotnet2. +
++ Please check http://www.sqlite.org/ for more information regarding SQLite. +
++ Author: Ioan Bizau +
++ In order to use this Driver you must have the SQLite.NET.dll Assembly available for NHibernate to load it. + You must also have the SQLite.dll and SQLite3.dll libraries. +
++ Please check http://www.sqlite.org/ for more information regarding SQLite. +
+
+ Abstracts ADO.NET batching to maintain the illusion that a single logical batch
+ exists for the whole session, even when batching is disabled.
+ Provides transparent
+ This will be useful once ADO.NET gets support for batching. Until that point + no code exists that will do batching, but this will provide a good point to do + error checking and making sure the correct number of rows were affected. +
+
+ ISession sess = factory.OpenSession();
+ ITransaction tx;
+ try {
+ tx = sess.BeginTransaction();
+ //do some work
+ ...
+ tx.Commit();
+ } catch (Exception e) {
+ if (tx != null) tx.Rollback();
+ throw;
+ } finally {
+ sess.Close();
+ }
+
+
+ This class implements useful common functionality that concrete loaders would delegate to.
+ It is not intended that this functionality would be directly accessed by client code (Hence,
+ all methods of this class are declared
+ The present implementation is able to load any number of columns of entities and at most + one collection role per query. +
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="assigned" />
+
+ <generator class="foreign">
+ <param name="property">AssociatedObject</param>
+ </generator>
+
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="guid.comb" />
+
+ The
+ This code was contributed by Donald Mull. +
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="guid" />
+
The built in strategies for identifier generation in NHibernate are:
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="identity" />
+ or if the database natively supports identity columns
+ <generator class="native" />
+
+ This indicates to NHibernate that the database generates the id when + the entity is inserted. +
+
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="sequence">
+ <param name="sequence">uid_sequence</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="seqhilo">
+ <param name="sequence">uid_sequence</param>
+ <param name="max_lo">max_lo_value</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ The user may specify a
+ It is not intended that applications use this strategy directly. However,
+ it may be used to build other (efficient) strategies. The return type is
+
+ The hi value MUST be fetched in a seperate transaction to the
+ The mapping parameters
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="hilo">
+ <param name="table">table</param>
+ <param name="column">id_column</param>
+ <param name="max_lo">max_lo_value</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ The hi value MUST be fecthed in a seperate transaction to the
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="uuid.hex">
+ <param name="format">format_string</param>
+ <param name="seperator">seperator_string</param>
+ </generator>
+
+
+ The
+ The identifier string will consist of only hex digits. Optionally, the identifier string + may be generated with enclosing characters and seperators between each component + of the UUID. If there are seperators then the string length will be 36. If a format + that has enclosing brackets is used, then the string length will be 38. +
+
+
+
+ This class is based on
+ This id generation strategy is specified in the mapping file as
+ <generator class="uuid.string" />
+
+ SetParameter("foo", foo, NHibernateUtil.Int32);
+
+ for example. A name may appear multiple times in the query string.
+ + Entities returned as results are initialized on demand. The first SQL query returns + identifiers only. +
+
+ This is a good strategy to use if you expect a high number of the objects
+ returned to be already loaded in the
+ IList cats = session.CreateCriteria(typeof(Cat))
+ .Add( Expression.Like("name", "Iz%") )
+ .Add( Expression.Gt( "weight", minWeight ) )
+ .AddOrder( Order.Asc("age") )
+ .List();
+
+ You may navigate associations using
+ IList cats = session.CreateCriteria(typeof(Cat))
+ .CreateCriteria("kittens")
+ .Add( Expression.like("name", "Iz%") )
+ .List();
+
+
+ <sql-query-name name="mySqlQuery">
+ <return alias="person" class="eg.Person" />
+ SELECT {person}.NAME AS {person.name}, {person}.AGE AS {person.age}, {person}.SEX AS {person.sex}
+ FROM PERSON {person} WHERE {person}.NAME LIKE 'Hiber%'
+ </sql-query-name>
+
+
+ If a value is passed in that is wrapped by
+ The value returned by the getter is not Quoted. To get the
+ column name in quoted form use
+ If a value is passed in that is wrapped by
+ The value returned by the getter is not Quoted. To get the
+ column name in quoted form use
A strategy for persisting a collection role. Defines a contract between + the persistence strategy and the actual persistent collection framework + and session. Does not define operations that are required for querying + collections, or loading by outer join.
++ Implements persistence of a collection instance while the instance is + referenced in a particular role.
+
+ This class is highly coupled to the
+ The
+ The
+ This can store the length of the binary data that the
+ This is only needed by DataProviders (SqlClient) that need to specify a Size for the + IDbDataParameter. Most DataProvider(Oralce) don't need to set the Size so a + BinarySqlType would work just fine. +
+
+ This can store the length of the binary data that the
+ This is only needed by DataProviders (SqlClient) that need to specify a Size for the + IDbDataParameter. Most DataProvider(Oralce) don't need to set the Size so a + StringSqlType would work just fine. +
+
+ IList resultWithAliasedBean = s.CreateCriteria(typeof(Enrollment))
+ .CreateAlias("Student", "st")
+ .CreateAlias("Course", "co")
+ .SetProjection( Projections.ProjectionList()
+ .Add( Projections.Property("co.Description"), "CourseDescription" )
+ )
+ .SetResultTransformer( new AliasToBeanResultTransformer(typeof(StudentDTO)) )
+ .List();
+
+ StudentDTO dto = (StudentDTO)resultWithAliasedBean[0];
+
+
+ public enum MyEnum
+ {
+ On,
+ Off,
+ Dimmed
+ }
+
+
+
+ public class MyEnumStringType : NHibernate.Type.EnumStringType
+ {
+ public MyEnumStringType()
+ : base( typeof( MyEnum ) )
+ {
+ }
+ }
+
+
+
+ ...
+ <property name="Status" type="MyEnumStringType, AssemblyContaining" />
+ ...
+
+
+ + The value stored in the database depends on what your data provider is capable + of storing. So there is a possibility that the DateTime you save will not be + the same DateTime you get back when you check DateTime.Equals(DateTime) because + they will have their milliseconds off. +
+
+ For example - SQL Server 2000 is only accurate to 3.33 milliseconds. So if
+ NHibernate writes a value of
+ Please review the documentation of your Database server. +
+'T'/'F' to indicate true/false.
+ 'Y'/'N' to indicate true/false.
+
+ CREATE TABLE [dbo].[Log] (
+ [ID] [int] IDENTITY (1, 1) NOT NULL ,
+ [Date] [datetime] NOT NULL ,
+ [Thread] [varchar] (255) NOT NULL ,
+ [Level] [varchar] (20) NOT NULL ,
+ [Logger] [varchar] (255) NOT NULL ,
+ [Message] [varchar] (4000) NOT NULL
+ ) ON [PRIMARY]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ "DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"
+ "Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"
+ "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"
+ System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral
+ This is an optional package that you can download from
+ http://msdn.microsoft.com/downloads
+ search for ODBC .NET Data Provider.
+ System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ This is an optional package that you can download from
+ http://msdn.microsoft.com/downloads
+ search for .NET Managed Provider for Oracle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <mapping>
+ <level value="ERROR" />
+ <eventLogEntryType value="Error" />
+ </mapping>
+ <mapping>
+ <level value="DEBUG" />
+ <eventLogEntryType value="Information" />
+ </mapping>
+
+
+
+
+
+
+ IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
+ UdpClient udpClient;
+ byte[] buffer;
+ string loggingEvent;
+
+ try
+ {
+ udpClient = new UdpClient(8080);
+
+ while(true)
+ {
+ buffer = udpClient.Receive(ref remoteEndPoint);
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
+ Console.WriteLine(loggingEvent);
+ }
+ }
+ catch(Exception e)
+ {
+ Console.WriteLine(e.ToString());
+ }
+
+
+ Dim remoteEndPoint as IPEndPoint
+ Dim udpClient as UdpClient
+ Dim buffer as Byte()
+ Dim loggingEvent as String
+
+ Try
+ remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
+ udpClient = new UdpClient(8080)
+
+ While True
+ buffer = udpClient.Receive(ByRef remoteEndPoint)
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
+ Console.WriteLine(loggingEvent)
+ Wend
+ Catch e As Exception
+ Console.WriteLine(e.ToString())
+ End Try
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+
+
+
+
+
+ log4net configuration XML goes here
+
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.Info("Application Start");
+ log.Debug("This is a debug message");
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is another debug message");
+ }
+
+
+ log.Debug("This is entry number: " + i );
+
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ private static readonly bool isDebugEnabled = log.IsDebugEnabled;
+
+
+ if (isDebugEnabled)
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ log.Debug("This is entry number: " + i );
+
+
+ if (log.IsDebugEnabled())
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ {key1=value1, key2=value2, key3=value3}
+
+
+ StringWriter writer = new StringWriter();
+ Layout.Format(writer, loggingEvent);
+ string formattedEvent = writer.ToString();
+
+
+ ILog log = LogManager.GetLogger(typeof(TestApp));
+ log.Debug("Message 1");
+ log.Warn("Message 2");
+
+
+ DEBUG [main]: Message 1
+ WARN [main]: Message 2
+
+ | Format modifier | +left justify | +minimum width | +maximum width | +comment | +
|---|---|---|---|---|
| %20logger | +false | +20 | +none | +
+ |
+
| %-20logger | +true | +20 | +none | +
+ |
+
| %.30logger | +NA | +none | +30 | +
+ |
+
| false | +20 | +30 | +
+ |
+ |
| %-20.30logger | +true | +20 | +30 | +
+ |
+
%timestamp [%thread] %level %logger %ndc - %message%newline
+ %-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline
+
+ DEBUG - Hello world
+
+
+ <?xml version="1.0" ?>
+
+ <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]>
+
+ <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2>
+ &data;
+ </log4net:events>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
+
+
+ string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
+
+
+ using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
+ {
+ log.Warn("This should have an ThreadContext Stack message");
+ }
+
+
+ GlobalContext.Properties["hostname"] = Environment.MachineName;
+
+
+ LogicalThreadContext.Properties["user"] = userName;
+ log.Info("This log message has a LogicalThreadContext Property called 'user'");
+
+
+ using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
+ {
+ log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
+
+ } // at the end of the using block the message is automatically popped
+
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.Info("Application Start");
+ log.Debug("This is a debug message");
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is another debug message");
+ }
+
+
+ using(NDC.Push("my context message"))
+ {
+ ... all log calls will have 'my context message' included ...
+
+ } // at the end of the using block the message is automatically removed
+
+
+ using(log4net.NDC.Push("NDC_Message"))
+ {
+ log.Warn("This should have an NDC message");
+ }
+
+
+ ThreadContext.Properties["user"] = userName;
+ log.Info("This log message has a ThreadContext Property called 'user'");
+
+
+ using(ThreadContext.Stacks["NDC"].Push("my context message"))
+ {
+ log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
+
+ } // at the end of the using block the message is automatically popped
+
+ You can use any object that implements the
To make a
It is also standard practice that at least one of your constructors takes an
A collection that contains no duplicate elements. This class models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
A collection that contains no duplicate elements. This interface models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
A collection that contains no duplicate elements. This interface models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
Implements an immutable (read-only)
Although this is advertised as immutable, it really isn't. Anyone with access to the
+
Implements a thread-safe
You can use any object that implements the
To make a
It is also standard practice that at least one of your constructors takes an
Implements an immutable (read-only)
Although this is advertised as immutable, it really isn't. Anyone with access to the
+
+ Abstracts ADO.NET batching to maintain the illusion that a single logical batch
+ exists for the whole session, even when batching is disabled.
+ Provides transparent
+ This will be useful once ADO.NET gets support for batching. Until that point + no code exists that will do batching, but this will provide a good point to do + error checking and making sure the correct number of rows were affected. +
+
+ configuration.Configure("path/to/hibernate.cfg.xml");
+
+
+ If this ConnectionProvider is being Finalized (
+ If any subclasses manage resources that also need to be disposed of this method + should be overridden, but don't forget to call it in the override. +
+
+ List results = session.CreateCriteria(typeof(Parent))
+ .Add( Example.Create(parent).IgnoreCase() )
+ .CreateCriteria("child")
+ .Add( Example.Create( parent.Child ) )
+ .List();
+
+ concat(?1, ?2) to concatenate two strings
+ p1 and p2. Target SQL function will be dialect-specific, e.g. (?1 || ?2) for
+ Oracle, concat(?1, ?2) for MySql, (?1 + ?2) for MS SQL.
+ Each dialect will define a template as a string (exactly like above) marking function
+ parameters with '?' followed by parameter's index (first index is 1).
+
+ This method assumes that the name is not already Quoted. So if the name passed
+ in is
+ If the aliasName is already enclosed in the OpenQuote and CloseQuote then this + method will return the aliasName that was passed in without going through any + Quoting process. So if aliasName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the columnName is already enclosed in the OpenQuote and CloseQuote then this + method will return the columnName that was passed in without going through any + Quoting process. So if columnName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the tableName is already enclosed in the OpenQuote and CloseQuote then this + method will return the tableName that was passed in without going through any + Quoting process. So if tableName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the schemaName is already enclosed in the OpenQuote and CloseQuote then this + method will return the schemaName that was passed in without going through any + Quoting process. So if schemaName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
+
+ This method checks the string
+ After the OpenQuote and CloseQuote have been cleaned from the string
+ The following quoted values return these results + "quoted" = quoted + "quote""d" = quote"d + quote""d = quote"d +
++ If this implementation is not sufficient for your Dialect then it needs to be overridden. + MsSql2000Dialect is an example of where UnQuoting rules are different. +
+
+
+ SELECT TOP last (columns) FROM (
+ SELECT ROW_NUMBER() OVER(ORDER BY __hibernate_sort_expr_1__ {sort direction 1} [, __hibernate_sort_expr_2__ {sort direction 2}, ...]) as row, (query.columns) FROM (
+ {original select query part}, {sort field 1} as __hibernate_sort_expr_1__ [, {sort field 2} as __hibernate_sort_expr_2__, ...]
+ {remainder of original query minus the order by clause}
+ ) query
+ ) page WHERE page.row > offset
+
+
+
+ Note that we need to add explicitly specify the columns, because we need to be able to use them
+ in a paged subselect. NH-1155
+ + Author: Ioan Bizau +
++ This dialect probably will not work with schema-export. If anyone out there + can fill in the ctor with DbTypes to Strings that would be helpful. +
+ The SybaseDialect defaults the following configuration properties: ++ This dialect probably will not work with schema-export. If anyone out there + can fill in the ctor with DbTypes to Strings that would be helpful. +
+ The SybaseAnywhereDialect defaults the following configuration properties: +
+ Names.Put(DbType, "TEXT" );
+ Names.Put(DbType, 255, "VARCHAR($l)" );
+ Names.Put(DbType, 65534, "LONGVARCHAR($l)" );
+
+ will give you back the following:
+
+ Names.Get(DbType) // --> "TEXT" (default)
+ Names.Get(DbType,100) // --> "VARCHAR(100)" (100 is in [0:255])
+ Names.Get(DbType,1000) // --> "LONGVARCHAR(1000)" (100 is in [256:65534])
+ Names.Get(DbType,100000) // --> "TEXT" (default)
+
+ On the other hand, simply putting
+
+ Names.Put(DbType, "VARCHAR($l)" );
+
+ would result in
+
+ Names.Get(DbType) // --> "VARCHAR($l)" (will cause trouble)
+ Names.Get(DbType,100) // --> "VARCHAR(100)"
+ Names.Get(DbType,1000) // --> "VARCHAR(1000)"
+ Names.Get(DbType,10000) // --> "VARCHAR(10000)"
+
+
+ key="connection.driver_class"
+ value="FullyQualifiedClassName, AssemblyName"
+
+ IDbParameter param = cmd.Parameters["@paramName"]
+ if this is false the code will be
+ IDbParameter param = cmd.Parameters["paramName"].
+ + Author: Oliver Weichhold +
++ In order to use this Driver you must have the Npgsql.dll Assembly available for + NHibernate to load it. +
++ Please check the products website + http://www.postgresql.org/ + for any updates and or documentation. +
++ The homepage for the .NET DataProvider is: + http://pgfoundry.org/projects/npgsql. +
++ In order to use this driver you must have the System.Data.SQLite.dll assembly available + for NHibernate to load. This assembly includes the SQLite.dll or SQLite3.dll libraries. +
++ You can get the System.Data.SQLite.dll assembly from http://sourceforge.net/projects/sqlite-dotnet2. +
++ Please check http://www.sqlite.org/ for more information regarding SQLite. +
++ Author: Ioan Bizau +
++ In order to use this Driver you must have the SQLite.NET.dll Assembly available for NHibernate to load it. + You must also have the SQLite.dll and SQLite3.dll libraries. +
++ Please check http://www.sqlite.org/ for more information regarding SQLite. +
+
+ ISession sess = factory.OpenSession();
+ ITransaction tx;
+ try {
+ tx = sess.BeginTransaction();
+ //do some work
+ ...
+ tx.Commit();
+ } catch (Exception e) {
+ if (tx != null) tx.Rollback();
+ throw;
+ } finally {
+ sess.Close();
+ }
+
+
+ This class implements useful common functionality that concrete loaders would delegate to.
+ It is not intended that this functionality would be directly accessed by client code (Hence,
+ all methods of this class are declared
+ The present implementation is able to load any number of columns of entities and at most + one collection role per query. +
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="assigned" />
+
+ <generator class="foreign">
+ <param name="property">AssociatedObject</param>
+ </generator>
+
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="guid.comb" />
+
+ The
+ This code was contributed by Donald Mull. +
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="guid" />
+
The built in strategies for identifier generation in NHibernate are:
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="identity" />
+ or if the database natively supports identity columns
+ <generator class="native" />
+
+ This indicates to NHibernate that the database generates the id when + the entity is inserted. +
+
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="sequence">
+ <param name="sequence">uid_sequence</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="seqhilo">
+ <param name="sequence">uid_sequence</param>
+ <param name="max_lo">max_lo_value</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ The user may specify a
+ It is not intended that applications use this strategy directly. However,
+ it may be used to build other (efficient) strategies. The return type is
+
+ The hi value MUST be fetched in a seperate transaction to the
+ The mapping parameters
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="hilo">
+ <param name="table">table</param>
+ <param name="column">id_column</param>
+ <param name="max_lo">max_lo_value</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ The hi value MUST be fecthed in a seperate transaction to the
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="uuid.hex">
+ <param name="format">format_string</param>
+ <param name="seperator">seperator_string</param>
+ </generator>
+
+
+ The
+ The identifier string will consist of only hex digits. Optionally, the identifier string + may be generated with enclosing characters and seperators between each component + of the UUID. If there are seperators then the string length will be 36. If a format + that has enclosing brackets is used, then the string length will be 38. +
+
+
+
+ This class is based on
+ This id generation strategy is specified in the mapping file as
+ <generator class="uuid.string" />
+
+ SetParameter("foo", foo, NHibernateUtil.Int32);
+
+ for example. A name may appear multiple times in the query string.
+ + Entities returned as results are initialized on demand. The first SQL query returns + identifiers only. +
+
+ This is a good strategy to use if you expect a high number of the objects
+ returned to be already loaded in the
+ IList cats = session.CreateCriteria(typeof(Cat))
+ .Add( Expression.Like("name", "Iz%") )
+ .Add( Expression.Gt( "weight", minWeight ) )
+ .AddOrder( Order.Asc("age") )
+ .List();
+
+ You may navigate associations using
+ IList cats = session.CreateCriteria(typeof(Cat))
+ .CreateCriteria("kittens")
+ .Add( Expression.like("name", "Iz%") )
+ .List();
+
+
+ <sql-query-name name="mySqlQuery">
+ <return alias="person" class="eg.Person" />
+ SELECT {person}.NAME AS {person.name}, {person}.AGE AS {person.age}, {person}.SEX AS {person.sex}
+ FROM PERSON {person} WHERE {person}.NAME LIKE 'Hiber%'
+ </sql-query-name>
+
+
+ If a value is passed in that is wrapped by
+ The value returned by the getter is not Quoted. To get the
+ column name in quoted form use
+ If a value is passed in that is wrapped by
+ The value returned by the getter is not Quoted. To get the
+ column name in quoted form use
case when ... then ... end as ...
+ decode(pkvalue, key1, 1, key2, 2, ..., 0)
+
+ The
+ The
+ This can store the length of the binary data that the
+ This is only needed by DataProviders (SqlClient) that need to specify a Size for the + IDbDataParameter. Most DataProvider(Oralce) don't need to set the Size so a + BinarySqlType would work just fine. +
+
+ This can store the length of the binary data that the
+ This is only needed by DataProviders (SqlClient) that need to specify a Size for the + IDbDataParameter. Most DataProvider(Oralce) don't need to set the Size so a + StringSqlType would work just fine. +
+
+ IList resultWithAliasedBean = s.CreateCriteria(typeof(Enrollment))
+ .CreateAlias("Student", "st")
+ .CreateAlias("Course", "co")
+ .SetProjection( Projections.ProjectionList()
+ .Add( Projections.Property("co.Description"), "CourseDescription" )
+ )
+ .SetResultTransformer( new AliasToBeanResultTransformer(typeof(StudentDTO)) )
+ .List();
+
+ StudentDTO dto = (StudentDTO)resultWithAliasedBean[0];
+
+
+ public enum MyEnum
+ {
+ On,
+ Off,
+ Dimmed
+ }
+
+
+
+ public class MyEnumStringType : NHibernate.Type.EnumStringType
+ {
+ public MyEnumStringType()
+ : base( typeof( MyEnum ) )
+ {
+ }
+ }
+
+
+
+ ...
+ <property name="Status" type="MyEnumStringType, AssemblyContaining" />
+ ...
+
+
+ + The value stored in the database depends on what your data provider is capable + of storing. So there is a possibility that the DateTime you save will not be + the same DateTime you get back when you check DateTime.Equals(DateTime) because + they will have their milliseconds off. +
+
+ For example - SQL Server 2000 is only accurate to 3.33 milliseconds. So if
+ NHibernate writes a value of
+ Please review the documentation of your Database server. +
+'T'/'F' to indicate true/false.
+ 'Y'/'N' to indicate true/false.
+ any.
+
+ CREATE TABLE [dbo].[Log] (
+ [ID] [int] IDENTITY (1, 1) NOT NULL ,
+ [Date] [datetime] NOT NULL ,
+ [Thread] [varchar] (255) NOT NULL ,
+ [Level] [varchar] (20) NOT NULL ,
+ [Logger] [varchar] (255) NOT NULL ,
+ [Message] [varchar] (4000) NOT NULL
+ ) ON [PRIMARY]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ "DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"
+ "Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"
+ "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"
+ System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral
+ This is an optional package that you can download from
+ http://msdn.microsoft.com/downloads
+ search for ODBC .NET Data Provider.
+ System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ This is an optional package that you can download from
+ http://msdn.microsoft.com/downloads
+ search for .NET Managed Provider for Oracle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <mapping>
+ <level value="ERROR" />
+ <eventLogEntryType value="Error" />
+ </mapping>
+ <mapping>
+ <level value="DEBUG" />
+ <eventLogEntryType value="Information" />
+ </mapping>
+
+
+
+
+
+
+ IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
+ UdpClient udpClient;
+ byte[] buffer;
+ string loggingEvent;
+
+ try
+ {
+ udpClient = new UdpClient(8080);
+
+ while(true)
+ {
+ buffer = udpClient.Receive(ref remoteEndPoint);
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
+ Console.WriteLine(loggingEvent);
+ }
+ }
+ catch(Exception e)
+ {
+ Console.WriteLine(e.ToString());
+ }
+
+
+ Dim remoteEndPoint as IPEndPoint
+ Dim udpClient as UdpClient
+ Dim buffer as Byte()
+ Dim loggingEvent as String
+
+ Try
+ remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
+ udpClient = new UdpClient(8080)
+
+ While True
+ buffer = udpClient.Receive(ByRef remoteEndPoint)
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
+ Console.WriteLine(loggingEvent)
+ Wend
+ Catch e As Exception
+ Console.WriteLine(e.ToString())
+ End Try
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+
+
+
+
+
+ log4net configuration XML goes here
+
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.Info("Application Start");
+ log.Debug("This is a debug message");
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is another debug message");
+ }
+
+
+ log.Debug("This is entry number: " + i );
+
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ private static readonly bool isDebugEnabled = log.IsDebugEnabled;
+
+
+ if (isDebugEnabled)
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ log.Debug("This is entry number: " + i );
+
+
+ if (log.IsDebugEnabled())
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ {key1=value1, key2=value2, key3=value3}
+
+
+ StringWriter writer = new StringWriter();
+ Layout.Format(writer, loggingEvent);
+ string formattedEvent = writer.ToString();
+
+
+ ILog log = LogManager.GetLogger(typeof(TestApp));
+ log.Debug("Message 1");
+ log.Warn("Message 2");
+
+
+ DEBUG [main]: Message 1
+ WARN [main]: Message 2
+
+ | Format modifier | +left justify | +minimum width | +maximum width | +comment | +
|---|---|---|---|---|
| %20logger | +false | +20 | +none | +
+ |
+
| %-20logger | +true | +20 | +none | +
+ |
+
| %.30logger | +NA | +none | +30 | +
+ |
+
| false | +20 | +30 | +
+ |
+ |
| %-20.30logger | +true | +20 | +30 | +
+ |
+
%timestamp [%thread] %level %logger %ndc - %message%newline
+ %-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline
+
+ DEBUG - Hello world
+
+
+ <?xml version="1.0" ?>
+
+ <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]>
+
+ <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2>
+ &data;
+ </log4net:events>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
+
+
+ string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
+
+
+ using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
+ {
+ log.Warn("This should have an ThreadContext Stack message");
+ }
+
+
+ GlobalContext.Properties["hostname"] = Environment.MachineName;
+
+
+ LogicalThreadContext.Properties["user"] = userName;
+ log.Info("This log message has a LogicalThreadContext Property called 'user'");
+
+
+ using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
+ {
+ log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
+
+ } // at the end of the using block the message is automatically popped
+
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.Info("Application Start");
+ log.Debug("This is a debug message");
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is another debug message");
+ }
+
+
+ using(NDC.Push("my context message"))
+ {
+ ... all log calls will have 'my context message' included ...
+
+ } // at the end of the using block the message is automatically removed
+
+
+ using(log4net.NDC.Push("NDC_Message"))
+ {
+ log.Warn("This should have an NDC message");
+ }
+
+
+ ThreadContext.Properties["user"] = userName;
+ log.Info("This log message has a ThreadContext Property called 'user'");
+
+
+ using(ThreadContext.Stacks["NDC"].Push("my context message"))
+ {
+ log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
+
+ } // at the end of the using block the message is automatically popped
+
+ You can use any object that implements the
To make a
It is also standard practice that at least one of your constructors takes an
A collection that contains no duplicate elements. This class models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
A collection that contains no duplicate elements. This interface models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
A collection that contains no duplicate elements. This interface models the mathematical
+
None of the
The following table summarizes the binary operators that are supported by the
Implements an immutable (read-only)
Although this is advertised as immutable, it really isn't. Anyone with access to the
+
Implements a thread-safe
You can use any object that implements the
To make a
It is also standard practice that at least one of your constructors takes an
Implements an immutable (read-only)
Although this is advertised as immutable, it really isn't. Anyone with access to the
+
+ Abstracts ADO.NET batching to maintain the illusion that a single logical batch
+ exists for the whole session, even when batching is disabled.
+ Provides transparent
+ This will be useful once ADO.NET gets support for batching. Until that point + no code exists that will do batching, but this will provide a good point to do + error checking and making sure the correct number of rows were affected. +
+
+ configuration.Configure("path/to/hibernate.cfg.xml");
+
+
+ If this ConnectionProvider is being Finalized (
+ If any subclasses manage resources that also need to be disposed of this method + should be overridden, but don't forget to call it in the override. +
+
+ List results = session.CreateCriteria(typeof(Parent))
+ .Add( Example.Create(parent).IgnoreCase() )
+ .CreateCriteria("child")
+ .Add( Example.Create( parent.Child ) )
+ .List();
+
+ concat(?1, ?2) to concatenate two strings
+ p1 and p2. Target SQL function will be dialect-specific, e.g. (?1 || ?2) for
+ Oracle, concat(?1, ?2) for MySql, (?1 + ?2) for MS SQL.
+ Each dialect will define a template as a string (exactly like above) marking function
+ parameters with '?' followed by parameter's index (first index is 1).
+
+ This method assumes that the name is not already Quoted. So if the name passed
+ in is
+ If the aliasName is already enclosed in the OpenQuote and CloseQuote then this + method will return the aliasName that was passed in without going through any + Quoting process. So if aliasName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the columnName is already enclosed in the OpenQuote and CloseQuote then this + method will return the columnName that was passed in without going through any + Quoting process. So if columnName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the tableName is already enclosed in the OpenQuote and CloseQuote then this + method will return the tableName that was passed in without going through any + Quoting process. So if tableName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
++ If the schemaName is already enclosed in the OpenQuote and CloseQuote then this + method will return the schemaName that was passed in without going through any + Quoting process. So if schemaName is passed in already Quoted make sure that + you have escaped all of the chars according to your DataBase's specifications. +
+
+ This method checks the string
+ After the OpenQuote and CloseQuote have been cleaned from the string
+ The following quoted values return these results + "quoted" = quoted + "quote""d" = quote"d + quote""d = quote"d +
++ If this implementation is not sufficient for your Dialect then it needs to be overridden. + MsSql2000Dialect is an example of where UnQuoting rules are different. +
+
+
+ SELECT
+ TOP last (columns)
+ FROM
+ (SELECT (columns), ROW_NUMBER() OVER(ORDER BY {original order by, with un-aliased column names) as __hibernate_sort_row
+ {original from}) as query
+ WHERE query.__hibernate_sort_row > offset
+ ORDER BY query.__hibernate_sort_row
+
+
+
+ Note that we need to add explicitly specify the columns, because we need to be able to use them
+ in a paged subselect. NH-1155
+ + Author: Ioan Bizau +
++ This dialect probably will not work with schema-export. If anyone out there + can fill in the ctor with DbTypes to Strings that would be helpful. +
+ The SybaseDialect defaults the following configuration properties: ++ This dialect probably will not work with schema-export. If anyone out there + can fill in the ctor with DbTypes to Strings that would be helpful. +
+ The SybaseDialect defaults the following configuration properties: ++ This dialect probably will not work with schema-export. If anyone out there + can fill in the ctor with DbTypes to Strings that would be helpful. +
+ The SybaseAnywhereDialect defaults the following configuration properties: +
+ Names.Put(DbType, "TEXT" );
+ Names.Put(DbType, 255, "VARCHAR($l)" );
+ Names.Put(DbType, 65534, "LONGVARCHAR($l)" );
+
+ will give you back the following:
+
+ Names.Get(DbType) // --> "TEXT" (default)
+ Names.Get(DbType,100) // --> "VARCHAR(100)" (100 is in [0:255])
+ Names.Get(DbType,1000) // --> "LONGVARCHAR(1000)" (100 is in [256:65534])
+ Names.Get(DbType,100000) // --> "TEXT" (default)
+
+ On the other hand, simply putting
+
+ Names.Put(DbType, "VARCHAR($l)" );
+
+ would result in
+
+ Names.Get(DbType) // --> "VARCHAR($l)" (will cause trouble)
+ Names.Get(DbType,100) // --> "VARCHAR(100)"
+ Names.Get(DbType,1000) // --> "VARCHAR(1000)"
+ Names.Get(DbType,10000) // --> "VARCHAR(10000)"
+
+
+ key="connection.driver_class"
+ value="FullyQualifiedClassName, AssemblyName"
+
+ IDbParameter param = cmd.Parameters["@paramName"]
+ if this is false the code will be
+ IDbParameter param = cmd.Parameters["paramName"].
+ + Author: Oliver Weichhold +
++ In order to use this Driver you must have the Npgsql.dll Assembly available for + NHibernate to load it. +
++ Please check the products website + http://www.postgresql.org/ + for any updates and or documentation. +
++ The homepage for the .NET DataProvider is: + http://pgfoundry.org/projects/npgsql. +
++ In order to use this driver you must have the System.Data.SQLite.dll assembly available + for NHibernate to load. This assembly includes the SQLite.dll or SQLite3.dll libraries. +
++ You can get the System.Data.SQLite.dll assembly from http://sourceforge.net/projects/sqlite-dotnet2. +
++ Please check http://www.sqlite.org/ for more information regarding SQLite. +
++ Author: Ioan Bizau +
++ In order to use this Driver you must have the SQLite.NET.dll Assembly available for NHibernate to load it. + You must also have the SQLite.dll and SQLite3.dll libraries. +
++ Please check http://www.sqlite.org/ for more information regarding SQLite. +
+
+ ISession sess = factory.OpenSession();
+ ITransaction tx;
+ try {
+ tx = sess.BeginTransaction();
+ //do some work
+ ...
+ tx.Commit();
+ } catch (Exception e) {
+ if (tx != null) tx.Rollback();
+ throw;
+ } finally {
+ sess.Close();
+ }
+
+
+ This class implements useful common functionality that concrete loaders would delegate to.
+ It is not intended that this functionality would be directly accessed by client code (Hence,
+ all methods of this class are declared
+ The present implementation is able to load any number of columns of entities and at most + one collection role per query. +
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="assigned" />
+
+ <generator class="foreign">
+ <param name="property">AssociatedObject</param>
+ </generator>
+
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="guid.comb" />
+
+ The
+ This code was contributed by Donald Mull. +
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="guid" />
+
The built in strategies for identifier generation in NHibernate are:
+
+ This id generation strategy is specified in the mapping file as
+ <generator class="identity" />
+ or if the database natively supports identity columns
+ <generator class="native" />
+
+ This indicates to NHibernate that the database generates the id when + the entity is inserted. +
+
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="sequence">
+ <param name="sequence">uid_sequence</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="seqhilo">
+ <param name="sequence">uid_sequence</param>
+ <param name="max_lo">max_lo_value</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ The user may specify a
+ It is not intended that applications use this strategy directly. However,
+ it may be used to build other (efficient) strategies. The return type is
+
+ The hi value MUST be fetched in a seperate transaction to the
+ The mapping parameters
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="hilo">
+ <param name="table">table</param>
+ <param name="column">id_column</param>
+ <param name="max_lo">max_lo_value</param>
+ <param name="schema">db_schema</param>
+ </generator>
+
+
+ The
+ The hi value MUST be fecthed in a seperate transaction to the
+ This id generation strategy is specified in the mapping file as
+
+ <generator class="uuid.hex">
+ <param name="format">format_string</param>
+ <param name="seperator">seperator_string</param>
+ </generator>
+
+
+ The
+ The identifier string will consist of only hex digits. Optionally, the identifier string + may be generated with enclosing characters and seperators between each component + of the UUID. If there are seperators then the string length will be 36. If a format + that has enclosing brackets is used, then the string length will be 38. +
+
+
+
+ This class is based on
+ This id generation strategy is specified in the mapping file as
+ <generator class="uuid.string" />
+
+ SetParameter("foo", foo, NHibernateUtil.Int32);
+
+ for example. A name may appear multiple times in the query string.
+ + Entities returned as results are initialized on demand. The first SQL query returns + identifiers only. +
+
+ This is a good strategy to use if you expect a high number of the objects
+ returned to be already loaded in the
+ IList cats = session.CreateCriteria(typeof(Cat))
+ .Add( Expression.Like("name", "Iz%") )
+ .Add( Expression.Gt( "weight", minWeight ) )
+ .AddOrder( Order.Asc("age") )
+ .List();
+
+ You may navigate associations using
+ IList cats = session.CreateCriteria(typeof(Cat))
+ .CreateCriteria("kittens")
+ .Add( Expression.like("name", "Iz%") )
+ .List();
+
+
+ IList cats = session.CreateCriteria(typeof(Cat))
+ .setProjection( Projections.ProjectionList()
+ .Add( Projections.RowCount() )
+ .Add( Projections.Avg("weight") )
+ .Add( Projections.Max("weight") )
+ .Add( Projections.Min("weight") )
+ .Add( Projections.GroupProperty("color") )
+ )
+ .AddOrder( Order.Asc("color") )
+ .List();
+
+
+ <sql-query-name name="mySqlQuery">
+ <return alias="person" class="eg.Person" />
+ SELECT {person}.NAME AS {person.name}, {person}.AGE AS {person.age}, {person}.SEX AS {person.sex}
+ FROM PERSON {person} WHERE {person}.NAME LIKE 'Hiber%'
+ </sql-query-name>
+
+
+ If a value is passed in that is wrapped by
+ The value returned by the getter is not Quoted. To get the
+ column name in quoted form use
+ If a value is passed in that is wrapped by
+ The value returned by the getter is not Quoted. To get the
+ column name in quoted form use
case when ... then ... end as ...
+ decode(pkvalue, key1, 1, key2, 2, ..., 0)
+
+ The
+ The
+ This can store the length of the binary data that the
+ This is only needed by DataProviders (SqlClient) that need to specify a Size for the + IDbDataParameter. Most DataProvider(Oralce) don't need to set the Size so a + BinarySqlType would work just fine. +
+
+ This can store the length of the binary data that the
+ This is only needed by DataProviders (SqlClient) that need to specify a Size for the + IDbDataParameter. Most DataProvider(Oralce) don't need to set the Size so a + StringSqlType would work just fine. +
+
+ IList resultWithAliasedBean = s.CreateCriteria(typeof(Enrollment))
+ .CreateAlias("Student", "st")
+ .CreateAlias("Course", "co")
+ .SetProjection( Projections.ProjectionList()
+ .Add( Projections.Property("co.Description"), "CourseDescription" )
+ )
+ .SetResultTransformer( new AliasToBeanResultTransformer(typeof(StudentDTO)) )
+ .List();
+
+ StudentDTO dto = (StudentDTO)resultWithAliasedBean[0];
+
+ + The value stored in the database depends on what your data provider is capable + of storing. So there is a possibility that the DateTime you save will not be + the same DateTime you get back when you check DateTime.Equals(DateTime) because + they will have their milliseconds off. +
+
+ For example - SQL Server 2000 is only accurate to 3.33 milliseconds. So if
+ NHibernate writes a value of
+ Please review the documentation of your Database server. +
+
+ public enum MyEnum
+ {
+ On,
+ Off,
+ Dimmed
+ }
+
+
+
+ public class MyEnumStringType : NHibernate.Type.EnumStringType
+ {
+ public MyEnumStringType()
+ : base( typeof( MyEnum ) )
+ {
+ }
+ }
+
+
+
+ ...
+ <property name="Status" type="MyEnumStringType, AssemblyContaining" />
+ ...
+
+
+ 'T'/'F' to indicate true/false.
+ 'Y'/'N' to indicate true/false.
+ any.
+
+ CREATE TABLE [dbo].[Log] (
+ [ID] [int] IDENTITY (1, 1) NOT NULL ,
+ [Date] [datetime] NOT NULL ,
+ [Thread] [varchar] (255) NOT NULL ,
+ [Level] [varchar] (20) NOT NULL ,
+ [Logger] [varchar] (255) NOT NULL ,
+ [Message] [varchar] (4000) NOT NULL
+ ) ON [PRIMARY]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ "DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"
+ "Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"
+ "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"
+ System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral
+ This is an optional package that you can download from
+ http://msdn.microsoft.com/downloads
+ search for ODBC .NET Data Provider.
+ System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
+ This is an optional package that you can download from
+ http://msdn.microsoft.com/downloads
+ search for .NET Managed Provider for Oracle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <mapping>
+ <level value="ERROR" />
+ <eventLogEntryType value="Error" />
+ </mapping>
+ <mapping>
+ <level value="DEBUG" />
+ <eventLogEntryType value="Information" />
+ </mapping>
+
+
+
+
+
+
+ IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
+ UdpClient udpClient;
+ byte[] buffer;
+ string loggingEvent;
+
+ try
+ {
+ udpClient = new UdpClient(8080);
+
+ while(true)
+ {
+ buffer = udpClient.Receive(ref remoteEndPoint);
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
+ Console.WriteLine(loggingEvent);
+ }
+ }
+ catch(Exception e)
+ {
+ Console.WriteLine(e.ToString());
+ }
+
+
+ Dim remoteEndPoint as IPEndPoint
+ Dim udpClient as UdpClient
+ Dim buffer as Byte()
+ Dim loggingEvent as String
+
+ Try
+ remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
+ udpClient = new UdpClient(8080)
+
+ While True
+ buffer = udpClient.Receive(ByRef remoteEndPoint)
+ loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
+ Console.WriteLine(loggingEvent)
+ Wend
+ Catch e As Exception
+ Console.WriteLine(e.ToString())
+ End Try
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+
+
+
+
+
+ log4net configuration XML goes here
+
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+
+
+
+
+
+ using log4net.Config;
+ using System.IO;
+ using System.Configuration;
+
+ ...
+
+ XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
+
+
+
+
+
+
+
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.Info("Application Start");
+ log.Debug("This is a debug message");
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is another debug message");
+ }
+
+
+ log.Debug("This is entry number: " + i );
+
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ private static readonly bool isDebugEnabled = log.IsDebugEnabled;
+
+
+ if (isDebugEnabled)
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ log.Debug("This is entry number: " + i );
+
+
+ if (log.IsDebugEnabled())
+ {
+ log.Debug("This is entry number: " + i );
+ }
+
+
+ {key1=value1, key2=value2, key3=value3}
+
+
+ StringWriter writer = new StringWriter();
+ Layout.Format(writer, loggingEvent);
+ string formattedEvent = writer.ToString();
+
+
+ ILog log = LogManager.GetLogger(typeof(TestApp));
+ log.Debug("Message 1");
+ log.Warn("Message 2");
+
+
+ DEBUG [main]: Message 1
+ WARN [main]: Message 2
+
+ | Format modifier | +left justify | +minimum width | +maximum width | +comment | +
|---|---|---|---|---|
| %20logger | +false | +20 | +none | +
+ |
+
| %-20logger | +true | +20 | +none | +
+ |
+
| %.30logger | +NA | +none | +30 | +
+ |
+
| false | +20 | +30 | +
+ |
+ |
| %-20.30logger | +true | +20 | +30 | +
+ |
+
%timestamp [%thread] %level %logger %ndc - %message%newline
+ %-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline
+
+ DEBUG - Hello world
+
+
+ <?xml version="1.0" ?>
+
+ <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]>
+
+ <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2>
+ &data;
+ </log4net:events>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
+
+
+ string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
+
+
+ using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
+ {
+ log.Warn("This should have an ThreadContext Stack message");
+ }
+
+
+ GlobalContext.Properties["hostname"] = Environment.MachineName;
+
+
+ LogicalThreadContext.Properties["user"] = userName;
+ log.Info("This log message has a LogicalThreadContext Property called 'user'");
+
+
+ using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
+ {
+ log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
+
+ } // at the end of the using block the message is automatically popped
+
+
+ ILog log = LogManager.GetLogger("application-log");
+
+ log.Info("Application Start");
+ log.Debug("This is a debug message");
+
+ if (log.IsDebugEnabled)
+ {
+ log.Debug("This is another debug message");
+ }
+
+
+ using(NDC.Push("my context message"))
+ {
+ ... all log calls will have 'my context message' included ...
+
+ } // at the end of the using block the message is automatically removed
+
+
+ using(log4net.NDC.Push("NDC_Message"))
+ {
+ log.Warn("This should have an NDC message");
+ }
+
+
+ ThreadContext.Properties["user"] = userName;
+ log.Info("This log message has a ThreadContext Property called 'user'");
+
+
+ using(ThreadContext.Stacks["NDC"].Push("my context message"))
+ {
+ log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
+
+ } // at the end of the using block the message is automatically popped
+
+
+ A
+ All
+ The scheduler is not destroyed, and can be re-started at any time. +
++ The scheduler cannot be re-started. +
++ The scheduler cannot be re-started. +
+
+ If the given Trigger does not reference any
+ The
+ If the
+ If any
+ If any of the
+ If any of the
+ When
+ If any
+ Listeners in the 'global' list receive notification of execution events
+ for ALL
+ Listeners in the 'global' list receive notification of execution events
+ for ALL
+ This method is not cluster aware. That is, it will only return Jobs + currently executing in this Scheduler instance, not across the entire + cluster. +
++ Note that the list returned is an 'instantaneous' snap-shot, and that as + soon as it's returned, the true list of executing jobs may be different. +
+
+ If a group was paused, then the
+ If a group was resumed, then the
+ If a group was paused, then the
+ If a group was resumed, then the parameter will + be null. If all jobs were paused, then both parameters will be null. +
+
+ The
+ This method will not be invoked if the execution of the Job was vetoed
+ by a
+ Set the instanceId. +
+
+ This interface is very similar to the
+ Unless a database driver has some extremely-DB-specific
+ requirements, any IDriverDelegate implementation classes should extend the
+
+ Get the names of all of the triggers associated with the given job. +
+ ++ Get all of the listeners for a given job. +
+ ++ If instanceId is not null, then only the record for the identified + instance will be returned. +
++ If instanceId is not null, then only the record for the identified + instance will be returned. +
+
+ Determine if the specified error code is in the
+ Determine if the specified error code is in the
+ If removal of the
+ If removal of the
+ If there are no jobs in the given group name, the result should be a
+ zero-length array (not
+ If there are no triggers in the given group name, the result should be a
+ zero-length array (not
+ If there are no known group names, the result should be a zero-length
+ array (not
+ If there are no known group names, the result should be a zero-length
+ array (not
+ If there are no Calendars in the given group name, the result should be
+ a zero-length array (not
+ The JobStore should "remember" that the group is paused, and impose the + pause on any new jobs that are added to the group while the group is + paused. +
+
+ If the
+ If any
+ If any of the
+ If any of the
+ When
+ If any
+ Insert or update a job. +
+
+ If removal of the
+ If removal of the
+ If any
+ When
+ If any
+ Create a
+ Create a
+ Create a
+ Create a
+ Note that this Calendar is only has full-day precision. +
++ Note that this Calendar is only has full-day precision. +
+
+ It is important to remember that the cron expression here describes a set of
+ times to be excluded from firing. Whereas the cron expression in
+ CronTrigger describes a set of times that can
+ be included for firing. Thus, if a
+ Note when using
+ Note that this Calendar is only has full-day precision. +
++ Note that this Calendar is only has full-day precision. +
++ Note that this Calendar is only has full-day precision. +
++ Note that this Calendar is only has full-day precision. +
++ Note that this Calendar is only has full-day precision. +
++ Note that this Calendar is only has full-day precision. +
+
+ To create a scheduler that does not write anything to the database (is not
+ persistent), you can call
+ DirectSchedulerFactory.Instance.CreateVolatileScheduler(10); // 10 threads + // don't forget to start the scheduler: + DirectSchedulerFactory.Instance.GetScheduler().Start(); ++
+ Several create methods are provided for convenience. All create methods + eventually end up calling the create method with all the parameters: +
++ public void createScheduler(String schedulerName, string schedulerInstanceId, ThreadPool threadPool, JobStore jobStore, string rmiRegistryHost, int rmiRegistryPort) ++
+ Here is an example of using this method: +
+
+ // create the thread pool
+ SimpleThreadPool threadPool = new SimpleThreadPool(maxThreads, Thread.NORM_PRIORITY);
+ threadPool.Initialize();
+ // create the job store
+ JobStore jobStore = new RAMJobStore();
+ jobStore.Initialize();
+
+ DirectSchedulerFactory.Instance.CreateScheduler("My Quartz Scheduler", "My Instance", threadPool, jobStore, "localhost", 1099);
+ // don't forget to start the scheduler:
+ DirectSchedulerFactory.Instance.GetScheduler("My Quartz Scheduler", "My Instance").start();
+
+ + you must call createRemoteScheduler or createScheduler methods before + calling getScheduler() +
++ Returns a handle to all known Schedulers (made by any + StdSchedulerFactory instance.). +
++ This method is not cluster aware. That is, it will only return Jobs + currently executing in this Scheduler instance, not across the entire + cluster. +
+
+ Note that the list returned is an 'instantaneous' snap-shot, and that as
+ soon as it's returned, the true list of executing jobs may be different.
+ Also please read the doc associated with
+ When
+ The scheduler is not destroyed, and can be re-started at any time. +
+
+ If more than one instance of the identified job is currently executing,
+ the
+ If you wish to interrupt a specific instance of a job (when more than
+ one is executing) you can do so by calling
+
+ This method is not cluster aware. That is, it will only interrupt + instances of the identified InterruptableJob currently executing in this + Scheduler instance, not across the entire cluster. +
++ Note that the data returned is an 'instantaneous' snap-shot, and that as + soon as it's returned, the meta data values may be different. +
+
+ JobFactories may be of use to those wishing to have their application
+ produce
+ This implementation does not re-use any objects, it simply makes a new
+ JobRunShell each time
+ Note that the data returned is an 'instantaneous' snap-shot, and that as + soon as it's returned, the meta data values may be different. +
+
+ If more than one instance of the identified job is currently executing,
+ the
+ If you wish to interrupt a specific instance of a job (when more than
+ one is executing) you can do so by calling
+
+ This method is not cluster aware. That is, it will only interrupt + instances of the identified InterruptableJob currently executing in this + Scheduler instance, not across the entire cluster. +
++ By default a properties are loaded from App.config's quartz section. + If that fails, then the "quartz.properties" + file located (as a embedded resource) in Quartz.dll is loaded. If you + wish to use a file other than these defaults, you must define the system + property 'quartz.properties' to point to the file you want. +
+ ++ See the sample properties that are distributed with Quartz for + information about the various settings available within the file. +
+ +
+ Alternativly, you can explicitly Initialize the factory by calling one of
+ the
+ Instances of the specified
+ By default a properties file named "quartz.properties" is loaded from + the 'current working directory'. If that fails, then the + "quartz.properties" file located (as a resource) in the org/quartz + package is loaded. If you wish to use a file other than these defaults, + you must define the system property 'quartz.properties' to point to + the file you want. +
++ Returns a handle to the Scheduler with the given name, if it exists (if + it has already been instantiated). +
++ Returns a handle to all known Schedulers (made by any + StdSchedulerFactory instance.). +
+
+ The implementation may wish to set a result object on the
+ JobExecutionContext before this method exits. The result itself
+ is meaningless to Quartz, but may be informative to
+
Defaults to
Defaults to
+ The implementation may wish to set a result object on the
+ JobExecutionContext before this method exits. The result itself
+ is meaningless to Quartz, but may be informative to
+
+ The broadcasting behavior of this listener to delegate listeners may be + more convenient than registering all of the listeners directly with the + Trigger, and provides the flexibility of easily changing which listeners + get notified. +
+ ++ You may also register a number of Regular Expression patterns to match + the events against. If one or more patterns are registered, the broadcast + will only take place if the event applies to a job who's name/group + matches one or more of the patterns. +
++ The broadcasting behavior of this listener to delegate listeners may be + more convenient than registering all of the listeners directly with the + Trigger, and provides the flexibility of easily changing which listeners + get notified. +
+ ++ You may also register a number of Regular Expression patterns to match + the events against. If one or more patterns are registered, the broadcast + will only take place if the event applies to a trigger who's name/group + matches one or more of the patterns. +
+
+ It is called before the
+ It is called after the
+ Consideration should be given to how much time is spent in this method, + as it will affect all triggers that are misfiring. If you have lots + of triggers misfiring at once, it could be an issue it this method + does a lot. +
++ Generally an instance of this listener would be registered as a global + job listener, rather than being registered directly to a given job. +
++ If for some reason there is a failure creating the trigger for the + follow-up job (which would generally only be caused by a rare serious + failure in the system, or the non-existence of the follow-up job), an error + messsage is logged, but no other action is taken. If you need more rigorous + handling of the error, consider scheduling the triggering of the flow-up + job within your job itself. +
+
+ The methods in this class are empty so you only need to override the
+ subset for the
+ You are required to implement
+ This method will not be invoked if the execution of the Job was vetoed
+ by a
+ The methods in this class are empty so you only need to override the
+ subset for the
+ You are required to implement
+ The logged message is customizable by setting one of the following message
+ properties to a string that conforms to the syntax of
+ JobToBeFiredMessage - available message data are:
| Element | +Data Type | +Description | +
|---|---|---|
| 0 | +String | +The Job's Name. | +
| 1 | +String | +The Job's Group. | +
| 2 | +Date | +The current time. | +
| 3 | +String | +The Trigger's name. | +
| 4 | +String | +The Triggers's group. | +
| 5 | +Date | +The scheduled fire time. | +
| 6 | +Date | +The next scheduled fire time. | +
| 7 | +Integer | +The re-fire count from the JobExecutionContext. | +
+ JobSuccessMessage - available message data are:
| Element | +Data Type | +Description | +
|---|---|---|
| 0 | +String | +The Job's Name. | +
| 1 | +String | +The Job's Group. | +
| 2 | +Date | +The current time. | +
| 3 | +String | +The Trigger's name. | +
| 4 | +String | +The Triggers's group. | +
| 5 | +Date | +The scheduled fire time. | +
| 6 | +Date | +The next scheduled fire time. | +
| 7 | +Integer | +The re-fire count from the JobExecutionContext. | +
| 8 | +Object | +The string value (toString() having been called) of the result (if any) + that the Job set on the JobExecutionContext, with on it. "NULL" if no + result was set. | +
+ JobFailedMessage - available message data are:
| Element | +Data Type | +Description | +
|---|---|---|
| 0 | +String | +The Job's Name. | +
| 1 | +String | +The Job's Group. | +
| 2 | +Date | +The current time. | +
| 3 | +String | +The Trigger's name. | +
| 4 | +String | +The Triggers's group. | +
| 5 | +Date | +The scheduled fire time. | +
| 6 | +Date | +The next scheduled fire time. | +
| 7 | +Integer | +The re-fire count from the JobExecutionContext. | +
| 8 | +String | +The message from the thrown JobExecution Exception. + | +
+ JobWasVetoedMessage - available message data are:
| Element | +Data Type | +Description | +
|---|---|---|
| 0 | +String | +The Job's Name. | +
| 1 | +String | +The Job's Group. | +
| 2 | +Date | +The current time. | +
| 3 | +String | +The Trigger's name. | +
| 4 | +String | +The Triggers's group. | +
| 5 | +Date | +The scheduled fire time. | +
| 6 | +Date | +The next scheduled fire time. | +
| 7 | +Integer | +The re-fire count from the JobExecutionContext. | +
+ If you use
+ If you need direct access your plugin, you can have it explicitly put a
+ reference to itself in the
+ If you need direct access your plugin, you can have it explicitly put a
+ reference to itself in the
+ The logged message is customizable by setting one of the following message
+ properties to a string that conforms to the syntax of
+ TriggerFiredMessage - available message data are:
| Element | +Data Type | +Description | +
|---|---|---|
| 0 | +String | +The Trigger's Name. | +
| 1 | +String | +The Trigger's Group. | +
| 2 | +Date | +The scheduled fire time. | +
| 3 | +Date | +The next scheduled fire time. | +
| 4 | +Date | +The actual fire time. | +
| 5 | +String | +The Job's name. | +
| 6 | +String | +The Job's group. | +
| 7 | +Integer | +The re-fire count from the JobExecutionContext. | +
+ TriggerMisfiredMessage - available message data are:
| Element | +Data Type | +Description | +
|---|---|---|
| 0 | +String | +The Trigger's Name. | +
| 1 | +String | +The Trigger's Group. | +
| 2 | +Date | +The scheduled fire time. | +
| 3 | +Date | +The next scheduled fire time. | +
| 4 | +Date | +The actual fire time. (the time the misfire was detected/handled) | +
| 5 | +String | +The Job's name. | +
| 6 | +String | +The Job's group. | +
+ TriggerCompleteMessage - available message data are:
| Element | +Data Type | +Description | +
|---|---|---|
| 0 | +String | +The Trigger's Name. | +
| 1 | +String | +The Trigger's Group. | +
| 2 | +Date | +The scheduled fire time. | +
| 3 | +Date | +The next scheduled fire time. | +
| 4 | +Date | +The job completion time. | +
| 5 | +String | +The Job's name. | +
| 6 | +String | +The Job's group. | +
| 7 | +Integer | +The re-fire count from the JobExecutionContext. | +
| 8 | +Integer | +The trigger's resulting instruction code. | +
| 9 | +String | +A human-readable translation of the trigger's resulting instruction + code. | +
+ It is called before the
+ Consideration should be given to how much time is spent in this method, + as it will affect all triggers that are misfiring. If you have lots + of triggers misfiring at once, it could be an issue it this method + does a lot. +
+
+ It is called after the
+ The default value is
+ This class is useful when you know that your scheduler instance will be the + only one running on a particular machine. Each time the scheduler is + restarted, it will get the same instance id as long as the machine is not + renamed. +
+ +
+ This interface may be of use to those wishing to have specific control over
+ the mechanism by which the
+ It should be extremely rare for this method to throw an exception -
+ basically only the the case where there is no way at all to instantiate
+ and prepare the Job for execution. When the exception is thrown, the
+ Scheduler will move all triggers associated with the Job into the
+
+ It should be extremely rare for this method to throw an exception -
+ basically only the the case where there is no way at all to instantiate
+ and prepare the Job for execution. When the exception is thrown, the
+ Scheduler will move all triggers associated with the Job into the
+
+ As you should know, the ramification of this is that access is extrememly
+ fast, but the data is completely volatile - therefore this
+ If removal of the
+ If there are no ICalendars in the given group name, the result should be
+ a zero-length array (not
+ If there are no matches, a zero-length array should be returned. +
++ The JobStore should "remember" that the group is paused, and impose the + pause on any new triggers that are added to the group while the group is + paused. +
++ The JobStore should "remember" that the group is paused, and impose the + pause on any new jobs that are added to the group while the group is + paused. +
+
+ If any
+ If any of the
+ If any of the
+ When
+ If any
+
+ The pool has a fixed number of
{@link org.quartz.spi.ThreadPool} interface.
+ + Return the string representation of the key. The format will be: + <group>.<name>. +
+ ++ Get the group portion of the key. +
+ +
+ All keys must be
+ The xml document must conform to the format defined in + "job_scheduling_data.xsd" +
+ +
+ After creating an instance of this class, you should call one of the
+ The same instance can be used again and again, with the list of defined Jobs
+ being cleared each time you call a
+ See + http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#dateTime +
+
+ The key is the job name and the value is a
+ Cron expressions are comprised of 6 required fields and one optional field + separated by white space. The fields respectively are described as follows: +
+| Field Name | ++ | Allowed Values | ++ | Allowed Special Characters | +
|---|---|---|---|---|
| Seconds | ++ | 0-59 | ++ | , - /// / | +
| Minutes | ++ | 0-59 | ++ | , - /// / | +
| Hours | ++ | 0-23 | ++ | , - /// / | +
| Day-of-month | ++ | 1-31 | ++ | , - /// ? / L W C | +
| Month | ++ | 1-12 or JAN-DEC | ++ | , - /// / | +
| Day-of-Week | ++ | 1-7 or SUN-SAT | ++ | , - /// ? / L # | +
| Year (Optional) | ++ | empty, 1970-2099 | ++ | , - /// / | +
+ The '*' character is used to specify all values. For example, "*" + in the minute field means "every minute". +
++ The '?' character is allowed for the day-of-month and day-of-week fields. It + is used to specify 'no specific value'. This is useful when you need to + specify something in one of the two fields, but not the other. +
++ The '-' character is used to specify ranges For example "10-12" in + the hour field means "the hours 10, 11 and 12". +
++ The ',' character is used to specify additional values. For example + "MON,WED,FRI" in the day-of-week field means "the days Monday, + Wednesday, and Friday". +
++ The '/' character is used to specify increments. For example "0/15" + in the seconds field means "the seconds 0, 15, 30, and 45". And + "5/15" in the seconds field means "the seconds 5, 20, 35, and + 50". Specifying '*' before the '/' is equivalent to specifying 0 is + the value to start with. Essentially, for each field in the expression, there + is a set of numbers that can be turned on or off. For seconds and minutes, + the numbers range from 0 to 59. For hours 0 to 23, for days of the month 0 to + 31, and for months 1 to 12. The "/" character simply helps you turn + on every "nth" value in the given set. Thus "7/6" in the + month field only turns on month "7", it does NOT mean every 6th + month, please note that subtlety. +
++ The 'L' character is allowed for the day-of-month and day-of-week fields. + This character is short-hand for "last", but it has different + meaning in each of the two fields. For example, the value "L" in + the day-of-month field means "the last day of the month" - day 31 + for January, day 28 for February on non-leap years. If used in the + day-of-week field by itself, it simply means "7" or + "SAT". But if used in the day-of-week field after another value, it + means "the last xxx day of the month" - for example "6L" + means "the last friday of the month". When using the 'L' option, it + is important not to specify lists, or ranges of values, as you'll get + confusing results. +
++ The 'W' character is allowed for the day-of-month field. This character + is used to specify the weekday (Monday-Friday) nearest the given day. As an + example, if you were to specify "15W" as the value for the + day-of-month field, the meaning is: "the nearest weekday to the 15th of + the month". So if the 15th is a Saturday, the trigger will fire on + Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the + 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. + However if you specify "1W" as the value for day-of-month, and the + 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not + 'jump' over the boundary of a month's days. The 'W' character can only be + specified when the day-of-month is a single day, not a range or list of days. +
++ The 'L' and 'W' characters can also be combined for the day-of-month + expression to yield 'LW', which translates to "last weekday of the + month". +
++ The '#' character is allowed for the day-of-week field. This character is + used to specify "the nth" XXX day of the month. For example, the + value of "6#3" in the day-of-week field means the third Friday of + the month (day 6 = Friday and "#3" = the 3rd one in the month). + Other examples: "2#1" = the first Monday of the month and + "4#5" = the fifth Wednesday of the month. Note that if you specify + "#5" and there is not 5 of the given day-of-week in the month, then + no firing will occur that month. If the '#' character is used, there can + only be one expression in the day-of-week field ("3#1,6#3" is + not valid, since there are two expressions). +
++ +
++ The legal characters and the names of months and days of the week are not + case sensitive. +
++ NOTES: +
+ For those unfamiliar with "cron", this means being able to create a firing + schedule such as: "At 8:00am every Monday through Friday" or "At 1:30am + every last Friday of the month". +
+ +
+ The format of a "Cron-Expression" string is documented on the
+
+ Here are some full examples:
+
| Expression | ++ | Meaning | +
|---|---|---|
| "0 0 12 * * ?"" /> | ++ | Fire at 12pm (noon) every day" /> | +
| "0 15 10 ? * *"" /> | ++ | Fire at 10:15am every day" /> | +
| "0 15 10 * * ?"" /> | ++ | Fire at 10:15am every day" /> | +
| "0 15 10 * * ? *"" /> | ++ | Fire at 10:15am every day" /> | +
| "0 15 10 * * ? 2005"" /> | ++ | Fire at 10:15am every day during the year 2005" /> + | +
| "0 * 14 * * ?"" /> | ++ | Fire every minute starting at 2pm and ending at 2:59pm, every day" /> + | +
| "0 0/5 14 * * ?"" /> | ++ | Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day" /> + | +
| "0 0/5 14,18 * * ?"" /> | ++ | Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5 minutes starting at 6pm and ending at 6:55pm, every day" /> + | +
| "0 0-5 14 * * ?"" /> | ++ | Fire every minute starting at 2pm and ending at 2:05pm, every day" /> + | +
| "0 10,44 14 ? 3 WED"" /> | ++ | Fire at 2:10pm and at 2:44pm every Wednesday in the month of March." /> + | +
| "0 15 10 ? * MON-FRI"" /> | ++ | Fire at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday" /> + | +
| "0 15 10 15 * ?"" /> | ++ | Fire at 10:15am on the 15th day of every month" /> + | +
| "0 15 10 L * ?"" /> | ++ | Fire at 10:15am on the last day of every month" /> + | +
| "0 15 10 ? * 6L"" /> | ++ | Fire at 10:15am on the last Friday of every month" /> + | +
| "0 15 10 ? * 6L"" /> | ++ | Fire at 10:15am on the last Friday of every month" /> + | +
| "0 15 10 ? * 6L 2002-2005"" /> | ++ | Fire at 10:15am on every last friday of every month during the years 2002, 2003, 2004 and 2005" /> + | +
| "0 15 10 ? * 6#3"" /> | ++ | Fire at 10:15am on the third Friday of every month" /> + | +
+ Pay attention to the effects of '?' and '*' in the day-of-week and + day-of-month fields! +
+ ++ NOTES: +
+
+
+ Triggers can 'send' parameters/data to
+ Called when the
+ Called by the scheduler at the time a
+ After this method has been called,
+ If the returned value is
+ To be implemented by the concrete classes that extend this class. +
+
+ The implementation should update the
+ The implementation should update the
+ Changes made to this map during job execution are not re-persisted, and + in fact typically result in an illegal state. +
+
+ If not explicitly set, the default value is
+ Note that the return time *may* be in the past. +
+
+ If not explicitly set, the default value is
+ Usable by
+ If null, the start-time will also be set to the current time, the time + zone will be set the the system's default. +
++ This method should not be invoked by client code. +
++ This method should not be invoked by client code. +
+
+ If the returned value is
+ To be implemented by the concrete classes that extend this class. +
+
+ The implementation should update the
+ Determines whether the date and (optionally) time of the given Calendar + instance falls on a scheduled fire-time of this trigger. +
+ +
+ Equivalent to calling
+ Note that the value returned is NOT validated against the related + ICalendar (if any). +
+
+ After this method has been called,
+ Note that the return time *may* be in the past. +
+
+ The means of actually interrupting the Job must be implemented within the
+
+ If the Job performs some form of blocking I/O or similar functions, you may
+ want to consider having the
+
+ The
+
+
+ Note that the
+ If not explicitly set, the default value is
+ If not explicitly set, the default value is
+ If not explicitly set, the default value is
+ The
+
+ NOTE: this data is volatile - it is lost after the job execution + completes, and all TriggerListeners and JobListeners have been + notified. +
+
+ The
NOTE: Do not expect value 'set' into this JobDataMap to somehow be
+ set back onto a
+ Attempts to change the contents of this map typically result in an + illegal state. +
+ ++ Note: The Job instance is not available through remote scheduler + interfaces. +
+
+ The result itself is meaningless to Quartz, but may be informative
+ to
+ The result itself is meaningless to Quartz, but may be informative
+ to
+ NOTE: This instruction should typically only be used for
+ 'one-shot' (non-repeating) Triggers. If it is used on a trigger with a
+ repeat count > 0 then it is equivalent to the instruction
+
+ NOTE: Use of this instruction causes the trigger to 'forget' + the start-time and repeat-count that it was originally setup with (this + is only an issue if you for some reason wanted to be able to tell what + the original values were at some later time). +
++ NOTE: Use of this instruction causes the trigger to 'forget' + the start-time and repeat-count that it was originally setup with. + Instead, the repeat count on the trigger will be changed to whatever + the remaining repeat count is (this is only an issue if you for some + reason wanted to be able to tell what the original values were at some + later time). +
+ +
+ NOTE: This instruction could cause the
+ NOTE/WARNING: This instruction could cause the
+ All
+ Take, for example, the following calendar: +
+
+ July August September
+ Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa Su Mo Tu We Th Fr Sa
+ 1 W 1 2 3 4 5 W 1 2 W
+ W H 5 6 7 8 W W 8 9 10 11 12 W W H 6 7 8 9 W
+ W 11 12 13 14 15 W W 15 16 17 18 19 W W 12 13 14 15 16 W
+ W 18 19 20 21 22 W W 22 23 24 25 26 W W 19 20 21 22 23 W
+ W 25 26 27 28 29 W W 29 30 31 W 26 27 28 29 30
+ W
+
+ Where W's represent weekend days, and H's represent holidays, all of which
+ are excluded on a calendar associated with an
+
+ Note that
+ Note that
+ Because of the conceptual design of
+ The returned value is not guaranteed to be valid until after + the trigger has been added to the scheduler. +
+
+ Because of the conceptual design of
+ Therefore, for triggers with intervalType =
+
+ After this method has been called,
+ If the returned value is
+ If the misfire instruction is set to MISFIRE_INSTRUCTION_SMART_POLICY,
+ then the instruction will be interpreted as
+
+ Because of the conceptual design of
+ Because of the conceptual design of
+ In most cases, the default value of this setting (12) is sufficient (it + is highly unlikely, for example, that you will need to look at more than + 12 months of dates to ensure that your trigger will never fire again). + However, this setting is included to allow for the rare exceptions where + this might not be true. +
+
+ For example, if your trigger is associated with a calendar that excludes
+ a great many dates in the next 12 months, and hardly any following that,
+ it is possible (if
+ Create a
+ Create a
+ The message will read:
"Unable to store Job with name: '__' and
+ group: '__', because one already exists with this identification."
+
+ Create a
+ The message will read:
"Unable to store Trigger with name: '__' and
+ group: '__', because one already exists with this identification."
+
+ The format of the string looks something like this: +
+ Quartz Scheduler 'SchedulerName' with instanceId 'SchedulerInstanceId' Scheduler class: 'Quartz.Impl.StdScheduler' - running locally. Running since: '11:33am on Jul 19, 2002' Not currently paused. Number of Triggers fired: '123' Using thread pool 'Quartz.Simpl.SimpleThreadPool' - with '8' threads Using job-store 'Quartz.Impl.JobStore' - which supports persistence. ++ +
+ After this method has been called,
+ Note that the return time may be in the past. +
+
+ A
+ When the trigger is in the error state, the scheduler will make no + attempts to fire it. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its group or end-time set. + The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ If the day of the month specified does not occur in a given month, a + firing will not occur that month. (i.e. if dayOfMonth is specified as + 31, no firing will occur in the months of the year with fewer than 31 + days). +
++ The generated trigger will not have its group, + or end-time set. The Start time defaults to 'now'. +
++ If the day of the month specified does not occur in a given month, a + firing will not occur that month. (i.e. if dayOfMonth is specified as + 31, no firing will occur in the months of the year with fewer than 31 + days). +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its name, group, + or end-time set. The Start time defaults to 'now'. +
++ The generated trigger will not have its group, + or end-time set. The Start time defaults to 'now'. +
++ For example an input date with a time of 08:13:54 would result in a date + with the time of 09:00:00. If the date's time is in the 23rd hour, the + date's 'day' will be promoted, and the time will be set to 00:00:00. +
++ For example an input date with a time of 08:13:54 would result in a date + with the time of 08:00:00. +
++ For example an input date with a time of 08:13:54 would result in a date + with the time of 08:14:00. If the date's time is in the 59th minute, + then the hour (and possibly the day) will be promoted. +
++ For example an input date with a time of 08:13:54 would result in a date + with the time of 08:13:00. +
++ For example an input date with a time of 08:13:54.341 would result in a + date with the time of 08:13:00.000. +
++ For example an input date with a time of 08:13:54, and an input + minute-base of 5 would result in a date with the time of 08:15:00. The + same input date with an input minute-base of 10 would result in a date + with the time of 08:20:00. But a date with the time 08:53:31 and an + input minute-base of 45 would result in 09:00:00, because the even-hour + is the next 'base' for 45-minute intervals. +
+ ++ More examples:
| Input Time | +Minute-Base | +Result Time | +
|---|---|---|
| 11:16:41 | +20 | +11:20:00 | +
| 11:36:41 | +20 | +11:40:00 | +
| 11:46:41 | +20 | +12:00:00 | +
| 11:26:41 | +30 | +11:30:00 | +
| 11:36:41 | +30 | +12:00:00 | +
| 11:16:41 | +17 | +11:17:00 | +
| 11:17:41 | +17 | +11:34:00 | +
| 11:52:41 | +17 | +12:00:00 | +
| 11:52:41 | +5 | +11:55:00 | +
| 11:57:41 | +5 | +12:00:00 | +
| 11:17:41 | +0 | +12:00:00 | +
| 11:17:41 | +1 | +11:08:00 | +
+ The rules for calculating the second are the same as those for
+ calculating the minute in the method
+
+ NOTE: if this is a trigger that has previously fired within the given + date range, then firings which have already occured will not be listed + in the output List. +
+null
+ If the object is null then an null
+ If the object is null then an null
+ If the object is null then an null
+ If the object is null then an null
+ If the object is null then an null
+ If the object is null then an null
+ If the object is not null then an null
+ If the object is not null then an null
+ If the object is not null then an null
+ If the object is not null then an null
+ If the object is not null then an null
+ If the object is not null then an NaN value.
+ If the object is not NaN then an NaN value.
+ If the object is not NaN then an NaN value.
+ If the object is not NaN then an NaN value.
+ If the object is not NaN then an NaN value.
+ If the object is not NaN then an NaN value.
+ If the object is not NaN then an