RecordInfo (Oracle Big Data Spatial and Graph Vector Analysis Java API Reference)

java.lang.Object
- oracle.spatial.hadoop.vector.RecordInfo

All Implemented Interfaces:

java.io.Serializable, org.apache.hadoop.io.Writable
```
public class RecordInfo
extends java.lang.Object
implements org.apache.hadoop.io.Writable, java.io.Serializable
```
Writable class that contains a subset of the data of a certain record called source record, typically, the record's id and spatial information as a JGeometry instance. It may also contain information used to find the source record such as the path of the file where the record is stored, its start position and length in bytes. Additional information can be added as text fields which can be stored and retrieved. Note that as extra fields are added it will also increase the size of the RecordInfo instances when stored at disk.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static org.apache.hadoop.io.Text`	`EMPTY_TEXT`
`protected static byte`	`F_FIELDS`
`protected static byte`	`F_GEOM`
`protected static byte`	`F_ID`
`protected static byte`	`F_LENGTH`
`protected static byte`	`F_OFFSET`
`protected static byte`	`F_PATH`

Constructor Summary

Constructors
Constructor and Description

RecordInfo()
Creates a new empty instance

RecordInfo(RecordInfo recordInfo)
Creates a new instance from another instance.

Constructors
Constructor and Description
`RecordInfo()` Creates a new empty instance
`RecordInfo(RecordInfo recordInfo)` Creates a new instance from another instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears all the information held by the current instance.
`void`	`clearFields()` Clears the extra fields (names and values)
`java.lang.String`	`getField(java.lang.String name)` Gets the value of an extra field
`java.util.Collection<java.lang.String>`	`getFieldNames()` Gets the names of all the extra fields contained
`oracle.spatial.geometry.JGeometry`	`getGeometry()` Gets the geometry associated to the source record
`java.lang.String`	`getId()` Gets the id used to identify the source record
`long`	`getLength()` Gets the length in bytes of the source record
`int`	`getNumberOfFields()` Gets the number of extra fields contained by this instance.
`long`	`getOffset()` Gets the position in file of the source record as an offset in bytes.
`java.lang.String`	`getPath()` Gets the path (as a String) to the file containing the source record
`void`	`readFields(java.io.DataInput in)`
`java.lang.String`	`removeField(java.lang.String name)` Removes the extra field with the given name
`void`	`set(RecordInfo recordInfo)` Copies the content from another RecordInfo instance
`boolean`	`setField(java.lang.String name, java.lang.String value)` Adds an extra field.
`void`	`setGeometry(oracle.spatial.geometry.JGeometry geometry)` Sets the geometry associated to the source record
`void`	`setId(java.lang.String id)` Sets the id used to identify the source record
`void`	`setLength(long length)` Sets the length in bytes of the source record
`void`	`setNumberOfFields(int numberOfFields)` Sets the number of extra fields that will be held by the instance.
`void`	`setOffset(long offset)` Sets the position in file of the source record as an offset in bytes.
`void`	`setPath(java.lang.String path)` Sets the path (as a String) to the file containing the source record
`java.lang.String`	`toString()`
`void`	`write(java.io.DataOutput out)`

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

- Field Detail
  - F_ID
```
protected static byte F_ID
```
  - F_GEOM
```
protected static byte F_GEOM
```
  - F_OFFSET
```
protected static byte F_OFFSET
```
  - F_LENGTH
```
protected static byte F_LENGTH
```
  - F_PATH
```
protected static byte F_PATH
```
  - F_FIELDS
```
protected static byte F_FIELDS
```
  - EMPTY_TEXT
```
protected static final org.apache.hadoop.io.Text EMPTY_TEXT
```
- Constructor Detail
  - RecordInfo
```
public RecordInfo()
```
    Creates a new empty instance
  - RecordInfo
```
public RecordInfo(RecordInfo recordInfo)
```
    Creates a new instance from another instance. It is equivalent to create an empty instance and then call the set(RecordInfo) method.
    
    Parameters:
    
    recordInfo - a RecordInfo instance
- Method Detail
  - set
```
public void set(RecordInfo recordInfo)
```
    Copies the content from another RecordInfo instance
    
    Parameters:
    
    recordInfo - a RecordInfo instance
  - getId
```
public java.lang.String getId()
```
    Gets the id used to identify the source record
    
    Returns:
    
    the id of the record represented by the current instance
  - setId
```
public void setId(java.lang.String id)
```
    Sets the id used to identify the source record
    
    Parameters:
    
    id - the id of the record represented by the current instance
  - getOffset
```
public long getOffset()
```
    Gets the position in file of the source record as an offset in bytes.
    
    Returns:
    
    the position of the source record or -1 if it has not been set
  - setOffset
```
public void setOffset(long offset)
```
    Sets the position in file of the source record as an offset in bytes.
    
    Parameters:
    
    offset - the position of the source record
  - getLength
```
public long getLength()
```
    Gets the length in bytes of the source record
    
    Returns:
    
    the source record's length in bytes or 0 if it has not been set
  - setLength
```
public void setLength(long length)
```
    Sets the length in bytes of the source record
    
    Parameters:
    
    length - he source record's length in bytes
  - getPath
```
public java.lang.String getPath()
```
    Gets the path (as a String) to the file containing the source record
    
    Returns:
    
    a string representation of a path or null if it has not been set
  - setPath
```
public void setPath(java.lang.String path)
```
    Sets the path (as a String) to the file containing the source record
    
    Parameters:
    
    path - a string representation of a path
  - getGeometry
```
public oracle.spatial.geometry.JGeometry getGeometry()
```
    Gets the geometry associated to the source record
    
    Returns:
    
    a JGeometry instance or null if it has not been set
  - setGeometry
```
public void setGeometry(oracle.spatial.geometry.JGeometry geometry)
```
    Sets the geometry associated to the source record
    
    Parameters:
    
    geometry - a JGeometry instance
  - getNumberOfFields
```
public int getNumberOfFields()
```
    Gets the number of extra fields contained by this instance. None of the fields which can be accessed through setters and getters (id, geometry, path, offset, length) are considered as extra fields.
    
    Returns:
    
    the number of extra fields contained by the instance
  - getFieldNames
```
public java.util.Collection<java.lang.String> getFieldNames()
```
    Gets the names of all the extra fields contained
    
    Returns:
    
    a collection with the extra fields names
  - clear
```
public void clear()
```
    Clears all the information held by the current instance. After executing thins method the instance will be empty.
  - setNumberOfFields
```
public void setNumberOfFields(int numberOfFields)
```
    Sets the number of extra fields that will be held by the instance. The number of extra fields is not bounded by this parameter but it is recommended to set this number as close as possible to the real number of extra fields to avoid reallocating space.
    
    Parameters:
    
    numberOfFields - the number of extra fields contained by the instance
  - clearFields
```
public void clearFields()
```
    Clears the extra fields (names and values)
  - setField
```
public boolean setField(java.lang.String name,
                        java.lang.String value)
```
    Adds an extra field. If the field already exists, its value will be overwritten
    
    Parameters:
    
    name - the field's name
    
    value - the field's value
  - getField
```
public java.lang.String getField(java.lang.String name)
```
    Gets the value of an extra field
    
    Parameters:
    
    name - the extra field's name
    
    Returns:
    
    the extra field's value or null if the field was not found
  - removeField
```
public java.lang.String removeField(java.lang.String name)
```
    Removes the extra field with the given name
    
    Parameters:
    
    name - the extra field's name
    
    Returns:
    
    the value of the removed extra field
  - readFields
```
public void readFields(java.io.DataInput in)
                throws java.io.IOException
```
    Specified by:
    
    readFields in interface org.apache.hadoop.io.Writable
    
    Throws:
    
    java.io.IOException
  - write
```
public void write(java.io.DataOutput out)
           throws java.io.IOException
```
    Specified by:
    
    write in interface org.apache.hadoop.io.Writable
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class RecordInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

F_ID

F_GEOM

F_OFFSET

F_LENGTH

F_PATH

F_FIELDS

EMPTY_TEXT

Constructor Detail

RecordInfo

RecordInfo

Method Detail

set

getId

setId

getOffset

setOffset

getLength

setLength

getPath

setPath

getGeometry

setGeometry

getNumberOfFields

getFieldNames

clear

setNumberOfFields

clearFields

setField

getField

removeField

readFields

write

toString