RecordFactory (Metadata 11.2.2 API)

java.lang.Object
- org.teiid.metadata.index.RecordFactory

public class RecordFactory
extends Object

RuntimeAdapter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANNOTATION_TAGS_INDEX_VERSION` The version number that is associated with the change made to remove property value pairs from the annotation records any properties on annotations would now be indexed as part of the properties index.
`static int`	`COLUMN_INPUT_PARAMETER_FLAG_INDEX_VERSION` The version number that is associated with the change made to add an input parameter flag on columns.
`static int`	`COLUMN_NATIVE_TYPE_INDEX_VERSION` The version number that is associated with the change made to add native type property on columns.
`static int`	`COLUMN_NULL_DISTINCT_INDEX_VERSION` The version number that is associated with the change made to add count of null and distinct values for columns on the column records 7/8/2005.
`static int`	`CURRENT_INDEX_VERSION` The version number that is encoded with all newly created index records
`static int`	`DELIMITER_INDEX_VERSION` The version number that is associated with the change made to change the list delimiter.
`static int`	`INDEX_RECORD_BLOCK_SIZE`
`static int`	`NONVERSIONED_RECORD_INDEX_VERSION` The version number associated with any index records prior to the point when version information was encoded in newly created records
`static int`	`NONZERO_UNKNOWN_CARDINALITY`
`protected String`	`parentId`
`static int`	`PRIMITIVE_TYPE_ID_INDEX_VERSION` The version number that is associated with the change made to add primitive type ID on datatype records 02/28/2006.
`static int`	`PROCEDURE_UPDATE_COUNT_VERSION` The version number that is associated with the change made to add an update count to physical stored and XQuery procedures 04/29/2008.
`static String`	`PROTOCOL`
`static int`	`TABLE_MATERIALIZATION_INDEX_VERSION` The version number that is associated with the change made to add materialization property on tables.
`static int`	`TRANSFORMATION_UUID_INDEX_VERSION` The version number that is associated with the change made to add uuid for the transformation mapping root on the transformation records, uuids would now be indexed as part of the transformation index.
`static String`	`URI_REFERENCE_DELIMITER` Delimiter used to separate the URI string from the URI fragment

Constructor Summary

Constructors
Constructor and Description

RecordFactory()

Constructors
Constructor and Description
`RecordFactory()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Column`	`createColumnRecord(char[] record)` Create a ColumnRecord instance from the specified index record
`ColumnSet`	`createColumnSetRecord(char[] record, ColumnSet columnSet)` Create a ColumnSetRecord instance from the specified index record
`Datatype`	`createDatatypeRecord(char[] record)` Create a DatatypeRecord instance from the specified index record
`ForeignKey`	`createForeignKeyRecord(char[] record)` Create a ForeignKeyRecord instance from the specified index record
`Schema`	`createModelRecord(char[] record)` Create a ModelRecord instance from the specified index record
`ProcedureParameter`	`createProcedureParameterRecord(char[] record)` Create a ProcedureParameterRecord instance from the specified index record header\|defaultValue\|dataType\|length\|radix\|scale\|nullType\|precision\|paramType\|footer\|
`Procedure`	`createProcedureRecord(char[] record)` Create a ProcedureRecord instance from the specified index record
`Table`	`createTableRecord(char[] record)` Create a TableRecord instance from the specified index record
`TransformationRecordImpl`	`createTransformationRecord(char[] record)` Create a TransformationRecord instance from the specified index record
`static String`	`extractUUIDString(IEntryResult result)` Extract the UUID string from the IEntryResult
`boolean`	`getBooleanValue(char b)`
`static int`	`getContinuationSegmentNumber(String objectID, IEntryResult continuationResult)`
`protected static short`	`getKeyTypeForRecordType(char recordType)`
`char`	`getListDelimiter(int indexVersionNumber)`
`protected AbstractMetadataRecord`	`getMetadataRecord(char[] record)` Return the `AbstractMetadataRecord` instances for specified IEntryResult.
`List<AbstractMetadataRecord>`	`getMetadataRecord(IEntryResult[] queryResult)` Return a collection of `AbstractMetadataRecord` instances for the result obtained from executing `queryEntriesMatching`
`String`	`getObjectValue(String str)`
`String`	`getOptionalToken(List<String> tokens, int tokenIndex)`
`static List<String>`	`getStrings(char[] record, char listDelimiter)`
`static List<String>`	`getStrings(String record, char listDelimiter)`
`boolean`	`includeAnnotationProperties(int indexVersionNumber)`
`boolean`	`includeColumnNativeType(int indexVersionNumber)`
`boolean`	`includeColumnNullDistinctValues(int indexVersionNumber)`
`boolean`	`includeInputParameterFlag(int indexVersionNumber)`
`boolean`	`includeMaterializationFlag(int indexVersionNumber)`
`boolean`	`includeMaterializedTables(int indexVersionNumber)`
`boolean`	`includePrimitiveTypeIdValue(int indexVersionNumber)`
`boolean`	`includeTransformationUUID(int indexVersionNumber)`
`static IEntryResult`	`joinEntryResults(IEntryResult result, IEntryResult[] continuationResults, int blockSize)` Append the specified IEntryResult[] to the IEntryResult to create a single result representing an index entry that was split across multiple index records.

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

- Field Detail
  - PROTOCOL
```
public static final String PROTOCOL
```
    See Also:
    
    Constant Field Values
  - URI_REFERENCE_DELIMITER
```
public static final String URI_REFERENCE_DELIMITER
```
    Delimiter used to separate the URI string from the URI fragment
    
    See Also:
    
    Constant Field Values
  - INDEX_RECORD_BLOCK_SIZE
```
public static final int INDEX_RECORD_BLOCK_SIZE
```
    See Also:
    
    Constant Field Values
  - NONVERSIONED_RECORD_INDEX_VERSION
```
public static final int NONVERSIONED_RECORD_INDEX_VERSION
```
    The version number associated with any index records prior to the point when version information was encoded in newly created records
    
    See Also:
    
    Constant Field Values
  - DELIMITER_INDEX_VERSION
```
public static final int DELIMITER_INDEX_VERSION
```
    The version number that is associated with the change made to change the list delimiter. Added 07/22/2004.
    
    Since:
    
    4.1.1
    
    See Also:
    
    Constant Field Values
  - TABLE_MATERIALIZATION_INDEX_VERSION
```
public static final int TABLE_MATERIALIZATION_INDEX_VERSION
```
    The version number that is associated with the change made to add materialization property on tables. Added 08/18/2004.
    
    Since:
    
    4.2
    
    See Also:
    
    Constant Field Values
  - COLUMN_NATIVE_TYPE_INDEX_VERSION
```
public static final int COLUMN_NATIVE_TYPE_INDEX_VERSION
```
    The version number that is associated with the change made to add native type property on columns. Added 08/24/2004.
    
    Since:
    
    4.2
    
    See Also:
    
    Constant Field Values
  - COLUMN_INPUT_PARAMETER_FLAG_INDEX_VERSION
```
public static final int COLUMN_INPUT_PARAMETER_FLAG_INDEX_VERSION
```
    The version number that is associated with the change made to add an input parameter flag on columns. The flag is used to indicate if an element for a virtual table represents an input parameter. This change was made to support the Procedural-Relational Mapping project. Added 09/29/2004.
    
    Since:
    
    4.2
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_TAGS_INDEX_VERSION
```
public static final int ANNOTATION_TAGS_INDEX_VERSION
```
    The version number that is associated with the change made to remove property value pairs from the annotation records any properties on annotations would now be indexed as part of the properties index. Added 12/14/2004.
    
    Since:
    
    4.2
    
    See Also:
    
    Constant Field Values
  - TRANSFORMATION_UUID_INDEX_VERSION
```
public static final int TRANSFORMATION_UUID_INDEX_VERSION
```
    The version number that is associated with the change made to add uuid for the transformation mapping root on the transformation records, uuids would now be indexed as part of the transformation index. Added 1/13/2005.
    
    Since:
    
    4.2
    
    See Also:
    
    Constant Field Values
  - COLUMN_NULL_DISTINCT_INDEX_VERSION
```
public static final int COLUMN_NULL_DISTINCT_INDEX_VERSION
```
    The version number that is associated with the change made to add count of null and distinct values for columns on the column records 7/8/2005.
    
    Since:
    
    4.2
    
    See Also:
    
    Constant Field Values
  - PRIMITIVE_TYPE_ID_INDEX_VERSION
```
public static final int PRIMITIVE_TYPE_ID_INDEX_VERSION
```
    The version number that is associated with the change made to add primitive type ID on datatype records 02/28/2006.
    
    Since:
    
    5.0
    
    See Also:
    
    Constant Field Values
  - PROCEDURE_UPDATE_COUNT_VERSION
```
public static final int PROCEDURE_UPDATE_COUNT_VERSION
```
    The version number that is associated with the change made to add an update count to physical stored and XQuery procedures 04/29/2008.
    
    Since:
    
    5.0
    
    See Also:
    
    Constant Field Values
  - NONZERO_UNKNOWN_CARDINALITY
```
public static final int NONZERO_UNKNOWN_CARDINALITY
```
    See Also:
    
    Constant Field Values
  - CURRENT_INDEX_VERSION
```
public static final int CURRENT_INDEX_VERSION
```
    The version number that is encoded with all newly created index records
    
    See Also:
    
    Constant Field Values
  - parentId
```
protected String parentId
```
- Constructor Detail
  - RecordFactory
```
public RecordFactory()
```
- Method Detail
  - getMetadataRecord
```
public List<AbstractMetadataRecord> getMetadataRecord(IEntryResult[] queryResult)
```
    Return a collection of AbstractMetadataRecord instances for the result obtained from executing queryEntriesMatching
    
    Parameters:
    
    queryResult -
    
    container - Container reference to be set on the record
  - getMetadataRecord
```
protected AbstractMetadataRecord getMetadataRecord(char[] record)
```
    Return the AbstractMetadataRecord instances for specified IEntryResult.
    
    Parameters:
    
    entryResult -
  - joinEntryResults
```
public static IEntryResult joinEntryResults(IEntryResult result,
                                            IEntryResult[] continuationResults,
                                            int blockSize)
```
    Append the specified IEntryResult[] to the IEntryResult to create a single result representing an index entry that was split across multiple index records.
    
    Parameters:
    
    result -
    
    continuationResults -
    
    blockSize -
  - getContinuationSegmentNumber
```
public static int getContinuationSegmentNumber(String objectID,
                                               IEntryResult continuationResult)
```
  - extractUUIDString
```
public static String extractUUIDString(IEntryResult result)
```
    Extract the UUID string from the IEntryResult
    
    Parameters:
    
    result -
  - createModelRecord
```
public Schema createModelRecord(char[] record)
```
    Create a ModelRecord instance from the specified index record
  - createTransformationRecord
```
public TransformationRecordImpl createTransformationRecord(char[] record)
```
    Create a TransformationRecord instance from the specified index record
  - getKeyTypeForRecordType
```
protected static short getKeyTypeForRecordType(char recordType)
```
  - createTableRecord
```
public Table createTableRecord(char[] record)
```
    Create a TableRecord instance from the specified index record
  - createColumnRecord
```
public Column createColumnRecord(char[] record)
```
    Create a ColumnRecord instance from the specified index record
  - createColumnSetRecord
```
public ColumnSet createColumnSetRecord(char[] record,
                                       ColumnSet columnSet)
```
    Create a ColumnSetRecord instance from the specified index record
  - createForeignKeyRecord
```
public ForeignKey createForeignKeyRecord(char[] record)
```
    Create a ForeignKeyRecord instance from the specified index record
  - createDatatypeRecord
```
public Datatype createDatatypeRecord(char[] record)
```
    Create a DatatypeRecord instance from the specified index record
  - createProcedureRecord
```
public Procedure createProcedureRecord(char[] record)
```
    Create a ProcedureRecord instance from the specified index record
  - createProcedureParameterRecord
```
public ProcedureParameter createProcedureParameterRecord(char[] record)
```
    Create a ProcedureParameterRecord instance from the specified index record header|defaultValue|dataType|length|radix|scale|nullType|precision|paramType|footer|
  - getObjectValue
```
public String getObjectValue(String str)
```
  - getBooleanValue
```
public boolean getBooleanValue(char b)
```
  - getStrings
```
public static List<String> getStrings(String record,
                                      char listDelimiter)
```
  - getStrings
```
public static List<String> getStrings(char[] record,
                                      char listDelimiter)
```
  - getListDelimiter
```
public char getListDelimiter(int indexVersionNumber)
```
  - includeMaterializationFlag
```
public boolean includeMaterializationFlag(int indexVersionNumber)
```
  - includeMaterializedTables
```
public boolean includeMaterializedTables(int indexVersionNumber)
```
  - includeColumnNativeType
```
public boolean includeColumnNativeType(int indexVersionNumber)
```
  - includeColumnNullDistinctValues
```
public boolean includeColumnNullDistinctValues(int indexVersionNumber)
```
  - includePrimitiveTypeIdValue
```
public boolean includePrimitiveTypeIdValue(int indexVersionNumber)
```
  - includeInputParameterFlag
```
public boolean includeInputParameterFlag(int indexVersionNumber)
```
  - includeAnnotationProperties
```
public boolean includeAnnotationProperties(int indexVersionNumber)
```
  - includeTransformationUUID
```
public boolean includeTransformationUUID(int indexVersionNumber)
```
  - getOptionalToken
```
public String getOptionalToken(List<String> tokens,
                               int tokenIndex)
```

Class RecordFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOCOL

URI_REFERENCE_DELIMITER

INDEX_RECORD_BLOCK_SIZE

NONVERSIONED_RECORD_INDEX_VERSION

DELIMITER_INDEX_VERSION

TABLE_MATERIALIZATION_INDEX_VERSION

COLUMN_NATIVE_TYPE_INDEX_VERSION

COLUMN_INPUT_PARAMETER_FLAG_INDEX_VERSION

ANNOTATION_TAGS_INDEX_VERSION

TRANSFORMATION_UUID_INDEX_VERSION

COLUMN_NULL_DISTINCT_INDEX_VERSION

PRIMITIVE_TYPE_ID_INDEX_VERSION

PROCEDURE_UPDATE_COUNT_VERSION

NONZERO_UNKNOWN_CARDINALITY

CURRENT_INDEX_VERSION

parentId

Constructor Detail

RecordFactory

Method Detail

getMetadataRecord

getMetadataRecord

joinEntryResults

getContinuationSegmentNumber

extractUUIDString

createModelRecord

createTransformationRecord

getKeyTypeForRecordType

createTableRecord

createColumnRecord

createColumnSetRecord

createForeignKeyRecord

createDatatypeRecord

createProcedureRecord

createProcedureParameterRecord

getObjectValue

getBooleanValue

getStrings

getStrings

getListDelimiter

includeMaterializationFlag

includeMaterializedTables

includeColumnNativeType

includeColumnNullDistinctValues

includePrimitiveTypeIdValue

includeInputParameterFlag

includeAnnotationProperties

includeTransformationUUID

getOptionalToken