RegisterSign In

API Documentation: Class ODBClassDefinition

Package: com.mckoi.odb

An object that describes the fields of an instance of a named class.

Methods Summary

String getClassName()
ODBClassDefinition defineMember(String field_name, String class_name)
ODBClassDefinition defineMember(String field_name, String class_name, boolean mutable)
ODBClassDefinition defineString(String field_name)
ODBClassDefinition defineString(String field_name, boolean mutable)
ODBClassDefinition defineData(String field_name)
ODBClassDefinition defineList(String field_name, String element_class, ODBOrderSpecification collation_spec, boolean allow_duplicates)
ODBClassDefinition defineList(String field_name, String element_class, boolean allow_duplicates)

Method Details

String getClassName()

Returns the class definition.

ODBClassDefinition defineMember(String field_name, String class_name)

Defines a reference to an immutable object of the given class type.

ODBClassDefinition defineMember(String field_name, String class_name, boolean mutable)

Defines a reference to an object of the given class type. If 'mutable' is true then the field may be altered in the object instance.

ODBClassDefinition defineString(String field_name)

Defines an immutable inlined string member on the class.

ODBClassDefinition defineString(String field_name, boolean mutable)

Defines an inlined string member on the class. If 'mutable' is true then the field may be altered in the object instance.

ODBClassDefinition defineData(String field_name)

Defines a data element on the class.

ODBClassDefinition defineList(String field_name, String element_class, ODBOrderSpecification collation_spec, boolean allow_duplicates)

Adds a reference to a List object field type to the definition. The list may only contains objects with the given 'element_class' name. 'collation_spec' is the specification used for ordering the keys, and if 'allowed_duplicates' is true then duplicate keys are allowed in the list or false for only unique key values.

ODBClassDefinition defineList(String field_name, String element_class, boolean allow_duplicates)

Adds a reference to a List object field type that has no order field or collation spec (order is on the reference id value).

The text on this page is licensed under the Creative Commons Attribution 3.0 License. Java is a registered trademark of Oracle and/or its affiliates.
Mckoi is Copyright © 2000 - 2020 Diehl and Associates, Inc. All rights reserved.