DbmsBooleanImplementation

java.lang.Object
- be.SIRAPRISE.typeimplementations.AbstractTypeImplementation_V0105
- - be.SIRAPRISE.typeimplementations.AbstractJavaBackedTypeImplementation_V0105
  - - be.SIRAPRISE.typeimplementations.DbmsBooleanImplementation

All Implemented Interfaces:

PossRepImplementation, PossRepImplementation_V0105, java.io.Externalizable, java.io.Serializable
```
public final class DbmsBooleanImplementation
extends AbstractJavaBackedTypeImplementation_V0105
implements PossRepImplementation_V0105
```
The implementation for the system-defined Boolean type. The physical encoding of boolean values is a 4-byte integer that holds the value -1 for true, or the integer value 0 for false.

Author:

Erwin Smout

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`_FALSE` The numeric value for false
`static int`	`_TRUE` The numeric value for true
`static ScalarValueBuffer`	`falseValue` Value representing 'false'
`static ScalarValueBuffer`	`trueValue` Value representing 'true'

Constructor Summary

Constructors
Constructor and Description
`DbmsBooleanImplementation()` Deprecated. - this constructor is provided merely as a consequence of the requirements of the Externalizable machinery. If you need an object of this class in your applications, invoking the getInstance() method is the recommended way to get it.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReadOnlyMap<NameIdentifier,TypeDeclaration>`	`getComponentIdentifierTypeDeclarationsMap()` Gets a map of component names to corresponding type declarations.
`MyReadOnlyMap<java.lang.String,java.lang.String>`	`getComponentNameMap()` Gets a map of component/type names.
`ReadOnlyMap<java.lang.String,TypeDeclaration>`	`getComponentTypeDeclarationsMap()` Gets a map of component names to corresponding type declarations.
`ValueBuffer`	`getComponentValue(java.lang.String componentName, ScalarValueBuffer valueBuffer)` "Extracts" a possrep component value out of a value of the type
`ValueBuffer`	`getComponentValue(java.lang.String componentName, ValueBuffer valueBuffer)` "Extracts" a possrep component value out of a value of the type
`ValueBuffer`	`getComponentValue(java.lang.String componentName, ValueBuffer valueBuffer, Heading nonScalarHeading)` "Extracts" a possrep component value out of a value of the type.
`MyReadOnlyMap<java.lang.String,ValueBuffer>`	`getComponentValues(ValueBuffer valueBuffer, Heading nonScalarHeading)` Gets all the possrep component values for a given value of the type this possrep is for
`PossRepImplementation`	`getDefaultPossrepImplementation()` Gets the possrep implementation that is to be considered the default for the type.
`int`	`getEncodingLength()` Gets the fixed encoding length, if the type employs fixed-length encoding, i.e.
`MyReadOnlyMap<NameIdentifier,ValueBuffer>`	`getIdentifierComponentValues(ValueBuffer valueBuffer, Heading nonScalarHeading)` Gets all the possrep component values for a given value of the type this possrep is for
`static DbmsBooleanImplementation`	`getInstance()` Gets instance
`static boolean`	`getJavaBoolean(ValueBuffer buffer)` Converts a ValueBuffer holding a boolean into a java boolean
`static boolean`	`getNegatedJavaBoolean(ValueBuffer buffer)` Converts a ValueBuffer holding a boolean into a java boolean representing the negation of that boolean
`static ValueBuffer`	`getNegatedJavaBooleanBuffer(ValueBuffer buffer)` Converts a ValueBuffer holding a boolean into a java boolean
`MyReadOnlySet<PossRepImplementation>`	`getPossrepImplementations()` Gets the set of all PossRepImplementations for this type.
`java.lang.String`	`getPossrepName()` Gets the possrep name
`boolean`	`hasVariableLengthEncoding()` Determines whether the number of bytes used in the physical encoding is the same for any possible value of the type.
`void`	`readExternal(java.io.ObjectInput in)`
`ValueBuffer`	`valueFromComponentValues(java.util.Map<java.lang.String,ValueBuffer> componentValueMap)` Returns a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.
`ValueBuffer`	`valueFromExternalRepresentation(java.lang.String value, Heading nonScalarHeading)` Convert a value of this possrep's type to internal format.
`ValueBuffer`	`valueFromIdentifierComponentValues(java.util.Map<NameIdentifier,ValueBuffer> componentValueMap)` Returns a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.
`java.lang.String`	`valueToEscapedExternalRepresentation(ValueBuffer valueBuffer, Heading nonScalarHeading)` Converts a value in internal format to the appropriate textual representation of that value for this possrep.
`java.lang.String`	`valueToEscapedExternalRepresentationVerbose(ValueBuffer valueBuffer, Heading nonScalarHeading)` Converts a value in internal format to the appropriate textual representation of that value for this possrep, including the surrounding typename (i.e.
`java.lang.String`	`valueToExternalRepresentation(ValueBuffer valueBuffer, Heading nonScalarHeading)` Converts a value in internal format to the appropriate textual representation of that value for this possrep.
`java.lang.String`	`valueToExternalRepresentationVerbose(ValueBuffer valueBuffer, Heading nonScalarHeading)` Converts a value in internal format to the appropriate textual representation of that value for this possrep, including the surrounding typename (i.e.
`void`	`writeExternal(java.io.ObjectOutput out)`

Methods inherited from class be.SIRAPRISE.typeimplementations.AbstractJavaBackedTypeImplementation_V0105
getEqualityOperatorImplementation, getOrderingOperatorImplementation, getPossrepImplementation, getRootTypeName, isOfType

Methods inherited from class be.SIRAPRISE.typeimplementations.AbstractTypeImplementation_V0105
getCommonScalarSuperTypeImplementation, getOrdinalOperatorImplementations, getTypeName, getTypeNameIdentifier, valueFromEscapedExternalRepresentation, valueFromEscapedExternalRepresentation, valueFromEscapedExternalRepresentationWithoutException

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _FALSE
```
public static final int _FALSE
```
    The numeric value for false
    
    See Also:
    
    Constant Field Values
  - _TRUE
```
public static final int _TRUE
```
    The numeric value for true
    
    See Also:
    
    Constant Field Values
  - falseValue
```
public static final ScalarValueBuffer falseValue
```
    Value representing 'false'
  - trueValue
```
public static final ScalarValueBuffer trueValue
```
    Value representing 'true'
- Constructor Detail
  - DbmsBooleanImplementation
```
@Deprecated
public DbmsBooleanImplementation()
```
    Deprecated. - this constructor is provided merely as a consequence of the requirements of the Externalizable machinery. If you need an object of this class in your applications, invoking the getInstance() method is the recommended way to get it.
    
    Builds a DbmsBooleanImplementation
- Method Detail
  - getInstance
```
public static DbmsBooleanImplementation getInstance()
```
    Gets instance
    
    Returns:
    
    instance.
  - getJavaBoolean
```
public static boolean getJavaBoolean(ValueBuffer buffer)
```
    Converts a ValueBuffer holding a boolean into a java boolean
    
    Parameters:
    
    buffer - The ValueBuffer holding a boolean value
    
    Returns:
    
    true if the bytebuffer represents the SIRA_PRISE value for true ; false otherwise
  - getNegatedJavaBoolean
```
public static boolean getNegatedJavaBoolean(ValueBuffer buffer)
```
    Converts a ValueBuffer holding a boolean into a java boolean representing the negation of that boolean
    
    Parameters:
    
    buffer - The ValueBuffer holding a boolean value
    
    Returns:
    
    true if the bytebuffer represents the SIRA_PRISE value for true ; false otherwise
  - getNegatedJavaBooleanBuffer
```
public static ValueBuffer getNegatedJavaBooleanBuffer(ValueBuffer buffer)
```
    Converts a ValueBuffer holding a boolean into a java boolean
    
    Parameters:
    
    buffer - The ValueBuffer holding a boolean value
    
    Returns:
    
    true if the bytebuffer represents the SIRA_PRISE value for true ; false otherwise
  - getComponentIdentifierTypeDeclarationsMap
```
public ReadOnlyMap<NameIdentifier,TypeDeclaration> getComponentIdentifierTypeDeclarationsMap()
```
    Description copied from interface: PossRepImplementation_V0105
    
    Gets a map of component names to corresponding type declarations. The keys in the map are the names of the components of this possrep. The values in the map are the type declaration objects corresponding to the named component. The map can be empty, if this is a possrep that does not consist of components.
    
    Specified by:
    
    getComponentIdentifierTypeDeclarationsMap in interface PossRepImplementation_V0105
    
    Returns:
    
    a map of component/type names.
  - getComponentNameMap
```
public MyReadOnlyMap<java.lang.String,java.lang.String> getComponentNameMap()
```
    Description copied from interface: PossRepImplementation
    
    Gets a map of component/type names. The keys in the map are the names of the components of this possrep. The values in the map are the typenames corresponding to (the values for) the named component. Since both the keys and the values in the map are all names, they must both be all uppercase. The map can be empty, if this is a possrep that does not consist of components.
    
    Specified by:
    
    getComponentNameMap in interface PossRepImplementation
    
    Returns:
    
    a map of component/type names.
  - getComponentTypeDeclarationsMap
```
public ReadOnlyMap<java.lang.String,TypeDeclaration> getComponentTypeDeclarationsMap()
```
    Description copied from interface: PossRepImplementation
    
    Gets a map of component names to corresponding type declarations. The keys in the map are the names of the components of this possrep. The values in the map are the type declaration objects corresponding to the named component. The map can be empty, if this is a possrep that does not consist of components.
    
    Specified by:
    
    getComponentTypeDeclarationsMap in interface PossRepImplementation
    
    Returns:
    
    a map of component/type names.
  - getComponentValue
```
public ValueBuffer getComponentValue(java.lang.String componentName,
                                     ScalarValueBuffer valueBuffer)
```
    Description copied from interface: PossRepImplementation
    
    "Extracts" a possrep component value out of a value of the type
    
    Specified by:
    
    getComponentValue in interface PossRepImplementation
    
    Parameters:
    
    componentName - The possrep component Name
    
    valueBuffer - The scalarValueBuffer holding the value of which the possrep's component's value is to be extracted
    
    Returns:
    
    The value of the component in this possrep's representation of the given value
  - getComponentValue
```
public ValueBuffer getComponentValue(java.lang.String componentName,
                                     ValueBuffer valueBuffer)
```
    Description copied from interface: PossRepImplementation
    
    "Extracts" a possrep component value out of a value of the type
    
    Specified by:
    
    getComponentValue in interface PossRepImplementation
    
    Parameters:
    
    componentName - The possrep component Name
    
    valueBuffer - The scalarValueBuffer holding the value of which the possrep's component's value is to be extracted
    
    Returns:
    
    The value of the component in this possrep's representation of the given value
  - getComponentValue
```
public ValueBuffer getComponentValue(java.lang.String componentName,
                                     ValueBuffer valueBuffer,
                                     Heading nonScalarHeading)
```
    Description copied from interface: PossRepImplementation_V0105
    
    "Extracts" a possrep component value out of a value of the type. This method supersedes the getComponentValue() method of the PossRepImplementation14 interface.
    
    Specified by:
    
    getComponentValue in interface PossRepImplementation_V0105
    
    Parameters:
    
    componentName - The possrep component Name
    
    valueBuffer - The scalarValueBuffer holding the value of which the possrep's component's value is to be extracted
    
    nonScalarHeading - The heading defining the nonScalar type that the value in the (nonscalar) valueBuffer is of.
    
    Returns:
    
    The value of the component in this possrep's representation of the given value
  - getComponentValues
```
public MyReadOnlyMap<java.lang.String,ValueBuffer> getComponentValues(ValueBuffer valueBuffer,
                                                                      Heading nonScalarHeading)
```
    Description copied from interface: PossRepImplementation
    
    Gets all the possrep component values for a given value of the type this possrep is for
    
    Specified by:
    
    getComponentValues in interface PossRepImplementation
    
    Parameters:
    
    valueBuffer - The scalarValueBuffer holding the value of which the possrep's component's value is to be extracted
    
    nonScalarHeading - The heading defining the specific nonScalar type, if the type is nonScalar and the value is a body value alone
    
    Returns:
    
    a mapping of all the possrep component values for a given value of the type this possrep is for
  - getDefaultPossrepImplementation
```
public PossRepImplementation getDefaultPossrepImplementation()
```
    Description copied from class: AbstractTypeImplementation_V0105
    
    Gets the possrep implementation that is to be considered the default for the type. If the type does not provide any possrep(implementation)s at all, then this method should return null, and this type will be treated as a singleton type.
    
    Specified by:
    
    getDefaultPossrepImplementation in class AbstractTypeImplementation_V0105
    
    Returns:
    
    the possrep implementation that is to be considered the default for the type, or null if the type is a singleton.
  - getEncodingLength
```
public int getEncodingLength()
```
    Description copied from class: AbstractTypeImplementation_V0105
    
    Gets the fixed encoding length, if the type employs fixed-length encoding, i.e. if the hasVariableLengthEncoding() method returns 'false'. Types that employ variable-length encodings are required to return a negative value.
    
    Specified by:
    
    getEncodingLength in class AbstractTypeImplementation_V0105
    
    Returns:
    
    the fixed encoding length, if the type employs fixed-length encoding, i.e. if the hasVariableLengthEncoding() method returns 'false'. Types that employ variable-length encodings are required to return a negative value.
  - getIdentifierComponentValues
```
public MyReadOnlyMap<NameIdentifier,ValueBuffer> getIdentifierComponentValues(ValueBuffer valueBuffer,
                                                                              Heading nonScalarHeading)
```
    Description copied from interface: PossRepImplementation_V0105
    
    Gets all the possrep component values for a given value of the type this possrep is for
    
    Specified by:
    
    getIdentifierComponentValues in interface PossRepImplementation_V0105
    
    Parameters:
    
    valueBuffer - The scalarValueBuffer holding the value of which the possrep's component's value is to be extracted
    
    nonScalarHeading - The heading defining the specific nonScalar type, if the type is nonScalar and the value is a body value alone
    
    Returns:
    
    a mapping of all the possrep component values for a given value of the type this possrep is for
  - getPossrepImplementations
```
public MyReadOnlySet<PossRepImplementation> getPossrepImplementations()
```
    Description copied from class: AbstractTypeImplementation_V0105
    
    Gets the set of all PossRepImplementations for this type.
    
    Specified by:
    
    getPossrepImplementations in class AbstractTypeImplementation_V0105
    
    Returns:
    
    The set of all PossRepImplementations for this type.
  - getPossrepName
```
public java.lang.String getPossrepName()
```
    Description copied from interface: PossRepImplementation
    
    Gets the possrep name
    
    Specified by:
    
    getPossrepName in interface PossRepImplementation
    
    Returns:
    
    The possrep name
  - hasVariableLengthEncoding
```
public boolean hasVariableLengthEncoding()
```
    Description copied from class: AbstractTypeImplementation_V0105
    
    Determines whether the number of bytes used in the physical encoding is the same for any possible value of the type. E.g. an integer type can always use 4 or 8 bytes for the encodings of its values, a text type can use just the number of byte positions needed.
    
    Specified by:
    
    hasVariableLengthEncoding in class AbstractTypeImplementation_V0105
    
    Returns:
    
    true if the length (in bytes) of the physical space needed to hold an encoding of a value of this type, is the same for all values
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
  - valueFromComponentValues
```
public ValueBuffer valueFromComponentValues(java.util.Map<java.lang.String,ValueBuffer> componentValueMap)
                                     throws InvalidValueException
```
    Description copied from interface: PossRepImplementation
    
    Returns a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.
    
    Specified by:
    
    valueFromComponentValues in interface PossRepImplementation
    
    Parameters:
    
    componentValueMap - A Map holding component names and their corresponding values, held in a ValueBuffer.
    
    Returns:
    
    a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.
    
    Throws:
    
    InvalidValueException - If the given mapping of component names to component values does not constitute a valid value for the type
  - valueFromExternalRepresentation
```
public ValueBuffer valueFromExternalRepresentation(java.lang.String value,
                                                   Heading nonScalarHeading)
                                            throws InvalidValueException
```
    Description copied from interface: PossRepImplementation
    
    Convert a value of this possrep's type to internal format. The implementation is responsible for ensuring that the result is within bounds with the possrep's type's minimum or maximum logical size (and thus with the corresponding minimum and maximum physical encoding size). If the type is variable-length, then any length may be chosen for the ByteBuffer returned, as long as the encoding of the value fits within that byteBuffer length. If the encoding of a value takes less bytes than the chosen length, then the remaining bytes must be filled with null bytes (0x00). Failing to obey this rule will subvert certain checksum computations that are done internally by SIRA_PRISE, and thus cause it to possibly produce wrong results. Note that if a type is variable-length, then the first four bytes in the returned ScalarValueBuffer's ByteBuffer must hold the logical length of the value.
    
    Specified by:
    
    valueFromExternalRepresentation in interface PossRepImplementation
    
    Parameters:
    
    value - the value in external format.
    
    nonScalarHeading - The heading defining the specific nonScalar type, if the type is nonScalar and the value is a body value alone
    
    Returns:
    
    the value in internal format.
    
    Throws:
    
    InvalidValueException - If the textual representation does not represent a value of the possrep's type.
  - valueFromIdentifierComponentValues
```
public ValueBuffer valueFromIdentifierComponentValues(java.util.Map<NameIdentifier,ValueBuffer> componentValueMap)
                                               throws InvalidValueException
```
    Description copied from interface: PossRepImplementation_V0105
    
    Returns a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.
    
    Specified by:
    
    valueFromIdentifierComponentValues in interface PossRepImplementation_V0105
    
    Parameters:
    
    componentValueMap - A Map holding component names and their corresponding values, held in a ValueBuffer.
    
    Returns:
    
    a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.
    
    Throws:
    
    InvalidValueException - If the given mapping of component names to component values does not constitute a valid value for the type
  - valueToEscapedExternalRepresentation
```
public java.lang.String valueToEscapedExternalRepresentation(ValueBuffer valueBuffer,
                                                             Heading nonScalarHeading)
```
    Description copied from interface: PossRepImplementation
    
    Converts a value in internal format to the appropriate textual representation of that value for this possrep. In this method, all tokens of the SIRA_PRISE metalanguage must be output in 'escaped' format, i.e. each '(' character in the representation of the value must be represented as the string "\(", each ')' as a "\)" and each '\' as a "\\". Observe that this does NOT apply to the opening and closing parentheses that delimit the value of a component.
    
    Specified by:
    
    valueToEscapedExternalRepresentation in interface PossRepImplementation
    
    Parameters:
    
    valueBuffer - The value in internal format.
    
    nonScalarHeading - The heading defining the specific nonScalar type, if the type the value held in valueBuffer is of, is indeed nonScalar. Can be left null for scalar types, as they are not "defined" by a Heading.
    
    Returns:
    
    The string representation of the given value, for this possrep.
  - valueToEscapedExternalRepresentationVerbose
```
public java.lang.String valueToEscapedExternalRepresentationVerbose(ValueBuffer valueBuffer,
                                                                    Heading nonScalarHeading)
```
    Description copied from interface: PossRepImplementation_V0105
    
    Converts a value in internal format to the appropriate textual representation of that value for this possrep, including the surrounding typename (i.e. the integer 1 is rendered as INT(1)). In this method, all tokens of the SIRA_PRISE metalanguage must be output in 'escaped' format, i.e. each '(' character in the representation of the value must be represented as the string "\(", each ')' as a "\)" and each '\' as a "\\". Observe that this does NOT apply to the opening and closing parentheses that delimit the value of a component.
    
    Specified by:
    
    valueToEscapedExternalRepresentationVerbose in interface PossRepImplementation_V0105
    
    Parameters:
    
    valueBuffer - The value in internal format.
    
    nonScalarHeading - The heading defining the specific nonScalar type, if the type the value held in valueBuffer is of, is indeed nonScalar. Can be left null for scalar types, as they are not "defined" by a Heading.
    
    Returns:
    
    The string representation of the given value, for this possrep.
  - valueToExternalRepresentation
```
public java.lang.String valueToExternalRepresentation(ValueBuffer valueBuffer,
                                                      Heading nonScalarHeading)
```
    Description copied from interface: PossRepImplementation
    
    Converts a value in internal format to the appropriate textual representation of that value for this possrep.
    
    Specified by:
    
    valueToExternalRepresentation in interface PossRepImplementation
    
    Parameters:
    
    valueBuffer - The value in internal format.
    
    nonScalarHeading - The heading defining the specific nonScalar type, if the type the value held in valueBuffer is of, is indeed nonScalar. Can be left null for scalar types, as they are not "defined" by a Heading.
    
    Returns:
    
    The string representation of the given value, for this possrep.
  - valueToExternalRepresentationVerbose
```
public java.lang.String valueToExternalRepresentationVerbose(ValueBuffer valueBuffer,
                                                             Heading nonScalarHeading)
```
    Description copied from interface: PossRepImplementation_V0105
    
    Converts a value in internal format to the appropriate textual representation of that value for this possrep, including the surrounding typename (i.e. the integer 1 is rendered as INT(1)).
    
    Specified by:
    
    valueToExternalRepresentationVerbose in interface PossRepImplementation_V0105
    
    Parameters:
    
    valueBuffer - The value in internal format.
    
    nonScalarHeading - The heading defining the specific nonScalar type, if the type the value held in valueBuffer is of, is indeed nonScalar. Can be left null for scalar types, as they are not "defined" by a Heading.
    
    Returns:
    
    The string representation of the given value, for this possrep.
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable

Class DbmsBooleanImplementation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class be.SIRAPRISE.typeimplementations.AbstractJavaBackedTypeImplementation_V0105

Methods inherited from class be.SIRAPRISE.typeimplementations.AbstractTypeImplementation_V0105

Methods inherited from class java.lang.Object

Field Detail

_FALSE

_TRUE

falseValue

trueValue

Constructor Detail

DbmsBooleanImplementation

Method Detail

getInstance

getJavaBoolean

getNegatedJavaBoolean

getNegatedJavaBooleanBuffer

getComponentIdentifierTypeDeclarationsMap

getComponentNameMap

getComponentTypeDeclarationsMap

getComponentValue

getComponentValue

getComponentValue

getComponentValues

getDefaultPossrepImplementation

getEncodingLength

getIdentifierComponentValues

getPossrepImplementations

getPossrepName

hasVariableLengthEncoding

readExternal

valueFromComponentValues

valueFromExternalRepresentation

valueFromIdentifierComponentValues

valueToEscapedExternalRepresentation

valueToEscapedExternalRepresentationVerbose

valueToExternalRepresentation

valueToExternalRepresentationVerbose

writeExternal