com.softwareag.tamino.db.api.accessor
Class TDefineMode

java.lang.Object
  extended by com.softwareag.tamino.db.api.accessor.TDefineMode

public class TDefineMode
extends java.lang.Object

Class representing information to control a schema defintion.

Version:
$Revision: 1.2 $
Author:
Oliver.Kleber@softwareag.com

Constructor Summary
protected TDefineMode()
          Default constructor.
  TDefineMode(boolean test, boolean validate)
          Initializes the define mode.
 
Method Summary
 boolean equals(java.lang.Object other)
          Indicates whether some other object is "equal to" this one.
 java.lang.String getValue()
          Returns the value of this define mode.
 int hashCode()
          Returns a hash code value for the object.
 boolean isTest()
          Returns a boolean indicating whether or not the input schema should only be tested.
 boolean isValidate()
          Returns a boolean indicating whether or not the input schema should be validated.
 java.lang.String toString()
          Get a string representation for this TDefineMode object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TDefineMode

protected TDefineMode()
Default constructor.


TDefineMode

public TDefineMode(boolean test,
                   boolean validate)
Initializes the define mode. If the test parameter is true, Tamino only tests the input schema, but the schema is not defined in the database. If the validate parameter is true, first structure-based updefine tests are being performed for each doctype. If they fail, all instances of that doctype are validated against the new schema. No validation is being performed for the instances of non-XML doctypes.

Parameters:
test - indicates if the input schema should only be tested.
validate - indicates if the input schema should be validated.
Method Detail

isTest

public boolean isTest()
Returns a boolean indicating whether or not the input schema should only be tested.

Returns:
If true the schema is tested otherwise the schema is physically defined.

isValidate

public boolean isValidate()
Returns a boolean indicating whether or not the input schema should be validated.

Returns:
If true the schema is validated.

getValue

public java.lang.String getValue()
Returns the value of this define mode.

Returns:
the value.

equals

public boolean equals(java.lang.Object other)
Indicates whether some other object is "equal to" this one.

Overrides:
equals in class java.lang.Object
Parameters:
other - the reference object with which to compare.
Returns:
true if this object is the same as the other argument; false otherwise.

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. Overrides the Object.hashCode method.

Overrides:
hashCode in class java.lang.Object
Returns:
a hash code value for this object.

toString

public java.lang.String toString()
Get a string representation for this TDefineMode object.

Overrides:
toString in class java.lang.Object
Returns:
A string representation for this TDefineMode object.


Copyright (c) 2013 Software AG. All Rights Reserved.