GEdge (Apache Giraph Parent 1.3.0-SNAPSHOT API)

java.lang.Object
- org.apache.avro.specific.SpecificRecordBase
- - org.apache.gora.persistency.impl.PersistentBase
  - - org.apache.giraph.io.gora.generated.GEdge

All Implemented Interfaces:

Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericRecord, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord, org.apache.gora.persistency.Dirtyable, org.apache.gora.persistency.Persistent

Direct Known Subclasses:

GEdge.Tombstone
```
public class GEdge
extends org.apache.gora.persistency.impl.PersistentBase
implements org.apache.avro.specific.SpecificRecord, org.apache.gora.persistency.Persistent
```
Example class for defining a Giraph-Edge.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GEdge.Builder` RecordBuilder for GEdge instances.
`static class`	`GEdge.Field` Enum containing all data bean's fields.
`static class`	`GEdge.Tombstone` Tombstone class.

Nested classes/interfaces inherited from class org.apache.gora.persistency.impl.PersistentBase
org.apache.gora.persistency.impl.PersistentBase.PersistentData

Field Summary

Fields
Modifier and Type Field and Description

static org.apache.avro.Schema SCHEMAS
Schema used for the class.
- Fields inherited from interface org.apache.gora.persistency.Persistent
  DIRTY_BYTES_FIELD_NAME

Fields
Modifier and Type	Field and Description
`static org.apache.avro.Schema`	`SCHEMAS` Schema used for the class.

Constructor Summary

Constructors
Constructor and Description

GEdge()

Constructors
Constructor and Description
`GEdge()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`get(int field)` Gets field
`CharSequence`	`getEdgeId()` Gets the value of the 'edgeId' field.
`Float`	`getEdgeWeight()` Gets the value of the 'edgeWeight' field.
`int`	`getFieldsCount()` Gets the total field count.
`CharSequence`	`getLabel()` Gets the value of the 'label' field.
`org.apache.avro.Schema`	`getSchema()` Gets the schema
`GEdge.Tombstone`	`getTombstone()` Gets a tombstone
`CharSequence`	`getVertexInId()` Gets the value of the 'vertexInId' field.
`CharSequence`	`getVertexOutId()` Gets the value of the 'vertexOutId' field.
`boolean`	`isEdgeIdDirty(CharSequence value)` Checks the dirty status of the 'edgeId' field.
`boolean`	`isEdgeWeightDirty(Float value)` Checks the dirty status of the 'edgeWeight' field.
`boolean`	`isLabelDirty(CharSequence value)` Checks the dirty status of the 'label' field.
`boolean`	`isVertexInIdDirty(CharSequence value)` Checks the dirty status of the 'vertexInId' field.
`boolean`	`isVertexOutIdDirty(CharSequence value)` Checks the dirty status of the 'vertexOutId' field.
`static GEdge.Builder`	`newBuilder()` Creates a new GEdge RecordBuilder.
`static GEdge.Builder`	`newBuilder(GEdge.Builder other)` Creates a new GEdge RecordBuilder by copying an existing Builder
`static GEdge.Builder`	`newBuilder(GEdge other)` Creates a new GEdge RecordBuilder by copying an existing GEdge instance.
`GEdge`	`newInstance()` Gets a new instance
`void`	`put(int field, Object value)` Puts a value into a field.
`void`	`setEdgeId(CharSequence value)` Sets the value of the 'edgeId' field.
`void`	`setEdgeWeight(Float value)` Sets the value of the 'edgeWeight' field.
`void`	`setLabel(CharSequence value)` Sets the value of the 'label' field.
`void`	`setVertexInId(CharSequence value)` Sets the value of the 'vertexInId' field.
`void`	`setVertexOutId(CharSequence value)` Sets the value of the 'vertexOutId' field.

Methods inherited from class org.apache.gora.persistency.impl.PersistentBase
clear, clearDirty, clearDirty, clearDirty, equals, getUnmanagedFields, isDirty, isDirty, isDirty, setDirty, setDirty, setDirty

Methods inherited from class org.apache.avro.specific.SpecificRecordBase
compareTo, get, hashCode, put, toString

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

Methods inherited from interface org.apache.gora.persistency.Persistent
clear, clearDirty, clearDirty, getUnmanagedFields, isDirty, isDirty, setDirty, setDirty, setDirty

Methods inherited from interface org.apache.gora.persistency.Dirtyable
clearDirty, isDirty

- Field Detail
  - SCHEMAS
```
public static final org.apache.avro.Schema SCHEMAS
```
    Schema used for the class.
- Constructor Detail
  - GEdge
```
public GEdge()
```
- Method Detail
  - getFieldsCount
```
public int getFieldsCount()
```
    Gets the total field count.
    
    Specified by:
    
    getFieldsCount in class org.apache.gora.persistency.impl.PersistentBase
    
    Returns:
    
    int field count
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    Gets the schema
    
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Specified by:
    
    getSchema in class org.apache.avro.specific.SpecificRecordBase
    
    Returns:
    
    Schema
  - get
```
public Object get(int field)
```
    Gets field
    
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Specified by:
    
    get in class org.apache.avro.specific.SpecificRecordBase
    
    Parameters:
    
    field - index field.
    
    Returns:
    
    Object from an index.
  - put
```
public void put(int field,
                Object value)
```
    Puts a value into a field.
    
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Specified by:
    
    put in class org.apache.avro.specific.SpecificRecordBase
    
    Parameters:
    
    field - index of field used.
    
    value - value of field used.
  - getEdgeId
```
public CharSequence getEdgeId()
```
    Gets the value of the 'edgeId' field.
    
    Returns:
    
    CharSequence.
  - setEdgeId
```
public void setEdgeId(CharSequence value)
```
    Sets the value of the 'edgeId' field.
    
    Parameters:
    
    value - the value to set.
  - isEdgeIdDirty
```
public boolean isEdgeIdDirty(CharSequence value)
```
    Checks the dirty status of the 'edgeId' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Parameters:
    
    value - the value to set.
    
    Returns:
    
    boolean
  - getEdgeWeight
```
public Float getEdgeWeight()
```
    Gets the value of the 'edgeWeight' field.
    
    Returns:
    
    Float
  - setEdgeWeight
```
public void setEdgeWeight(Float value)
```
    Sets the value of the 'edgeWeight' field.
    
    Parameters:
    
    value - the value to set.
  - isEdgeWeightDirty
```
public boolean isEdgeWeightDirty(Float value)
```
    Checks the dirty status of the 'edgeWeight' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Parameters:
    
    value - the value to set.
    
    Returns:
    
    boolean
  - getVertexInId
```
public CharSequence getVertexInId()
```
    Gets the value of the 'vertexInId' field.
    
    Returns:
    
    CharSequence
  - setVertexInId
```
public void setVertexInId(CharSequence value)
```
    Sets the value of the 'vertexInId' field.
    
    Parameters:
    
    value - the value to set.
  - isVertexInIdDirty
```
public boolean isVertexInIdDirty(CharSequence value)
```
    Checks the dirty status of the 'vertexInId' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Parameters:
    
    value - the value to set.
    
    Returns:
    
    boolean
  - getVertexOutId
```
public CharSequence getVertexOutId()
```
    Gets the value of the 'vertexOutId' field.
    
    Returns:
    
    CharSequence
  - setVertexOutId
```
public void setVertexOutId(CharSequence value)
```
    Sets the value of the 'vertexOutId' field.
    
    Parameters:
    
    value - the value to set.
  - isVertexOutIdDirty
```
public boolean isVertexOutIdDirty(CharSequence value)
```
    Checks the dirty status of the 'vertexOutId' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Parameters:
    
    value - the value to set.
    
    Returns:
    
    boolean
  - getLabel
```
public CharSequence getLabel()
```
    Gets the value of the 'label' field.
    
    Returns:
    
    CharSequence
  - setLabel
```
public void setLabel(CharSequence value)
```
    Sets the value of the 'label' field.
    
    Parameters:
    
    value - the value to set.
  - isLabelDirty
```
public boolean isLabelDirty(CharSequence value)
```
    Checks the dirty status of the 'label' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Parameters:
    
    value - the value to set.
    
    Returns:
    
    boolean
  - newBuilder
```
public static GEdge.Builder newBuilder()
```
    Creates a new GEdge RecordBuilder.
    
    Returns:
    
    GEdge.Builder
  - newBuilder
```
public static GEdge.Builder newBuilder(GEdge.Builder other)
```
    Creates a new GEdge RecordBuilder by copying an existing Builder
    
    Parameters:
    
    other - GEdge.Builder
    
    Returns:
    
    org.apache.giraph.io.gora.generated.GEdge.Builder
  - newBuilder
```
public static GEdge.Builder newBuilder(GEdge other)
```
    Creates a new GEdge RecordBuilder by copying an existing GEdge instance.
    
    Parameters:
    
    other - GEdge
    
    Returns:
    
    org.apache.giraph.io.gora.generated.GEdge.Builder
  - getTombstone
```
public GEdge.Tombstone getTombstone()
```
    Gets a tombstone
    
    Specified by:
    
    getTombstone in interface org.apache.gora.persistency.Persistent
    
    Returns:
    
    GEdge.Tombstone
  - newInstance
```
public GEdge newInstance()
```
    Gets a new instance
    
    Specified by:
    
    newInstance in interface org.apache.gora.persistency.Persistent
    
    Returns:
    
    GEdge.

Class GEdge

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.gora.persistency.impl.PersistentBase

Field Summary

Fields inherited from interface org.apache.gora.persistency.Persistent

Constructor Summary

Method Summary

Methods inherited from class org.apache.gora.persistency.impl.PersistentBase

Methods inherited from class org.apache.avro.specific.SpecificRecordBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.gora.persistency.Persistent

Methods inherited from interface org.apache.gora.persistency.Dirtyable

Field Detail

SCHEMAS

Constructor Detail

GEdge

Method Detail

getFieldsCount

getSchema

get

put

getEdgeId

setEdgeId

isEdgeIdDirty

getEdgeWeight

setEdgeWeight

isEdgeWeightDirty

getVertexInId

setVertexInId

isVertexInIdDirty

getVertexOutId

setVertexOutId

isVertexOutIdDirty

getLabel

setLabel

isLabelDirty

newBuilder

newBuilder

newBuilder

getTombstone

newInstance