java.lang.Object
- com.alibaba.graphscope.fragment.adaptor.ImmutableEdgecutFragmentAdaptor<OID_T,VID_T,VDATA_T,EDATA_T>

All Implemented Interfaces:: IFragment<OID_T,VID_T,VDATA_T,EDATA_T>, Serializable

public class ImmutableEdgecutFragmentAdaptor<OID_T,VID_T,VDATA_T,EDATA_T>
extends Object
implements IFragment<OID_T,VID_T,VDATA_T,EDATA_T>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static String fragmentType

Constructor Summary

Constructors
Constructor	Description
`ImmutableEdgecutFragmentAdaptor(ImmutableEdgecutFragment<OID_T,VID_T,VDATA_T,EDATA_T> frag, Class<? extends OID_T> oidClass, Class<? extends VID_T> vidClass, Class<? extends VDATA_T> vdataClass, Class<? extends EDATA_T> edataClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`fid()`
`int`	`fnum()`	Number of fragments.
`FragmentType`	`fragmentType()`	Return the underlying fragment type,i.e.
`VDATA_T`	`getData(Vertex<VID_T> vertex)`	Get the data on vertex.
`Class<? extends EDATA_T>`	`getEdataClass()`
`long`	`getEdgeNum()`	Returns the number of edges in this fragment.
`com.alibaba.fastffi.FFIPointer`	`getFFIPointer()`	Get the actual fragment FFIPointer we are using.
`int`	`getFragId(Vertex<VID_T> vertex)`	To which fragment the vertex belongs.
`OID_T`	`getId(Vertex<VID_T> vertex)`	Get the original Id of a vertex.
`ImmutableEdgecutFragment<OID_T,VID_T,VDATA_T,EDATA_T>`	`getImmutableFragment()`
`AdjList<VID_T,EDATA_T>`	`getIncomingAdjList(Vertex<VID_T> vertex)`
`long`	`getInEdgeNum()`
`boolean`	`getInnerVertex(OID_T oid, Vertex<VID_T> vertex)`	Check whether a vertex, represented in OID_T, is a inner vertex.
`VID_T`	`getInnerVertexGid(Vertex<VID_T> vertex)`	Convert from outer vertex handle to its global id.
`OID_T`	`getInnerVertexId(Vertex<VID_T> vertex)`	Obtain vertex id from original id, only for inner vertex.
`long`	`getInnerVerticesNum()`	Get the number of inner vertices.
`int`	`getLocalInDegree(Vertex<VID_T> vertex)`
`int`	`getLocalOutDegree(Vertex<VID_T> vertex)`
`Class<? extends OID_T>`	`getOidClass()`
`long`	`getOutEdgeNum()`
`boolean`	`getOuterVertex(OID_T oid, Vertex<VID_T> vertex)`	Check whether a vertex, represented in OID_T, is a outer vertex.
`VID_T`	`getOuterVertexGid(Vertex<VID_T> vertex)`	Convert from inner vertex handle to its global id.
`OID_T`	`getOuterVertexId(Vertex<VID_T> vertex)`	Obtain vertex id from original id, only for outer vertex.
`long`	`getOuterVerticesNum()`	Get the number of outer vertices.
`AdjList<VID_T,EDATA_T>`	`getOutgoingAdjList(Vertex<VID_T> vertex)`
`long`	`getTotalVerticesNum()`	Returns the number of vertices in the entire graph.
`Class<? extends VDATA_T>`	`getVdataClass()`
`boolean`	`getVertex(OID_T oid, Vertex<VID_T> vertex)`	Get the vertex handle from the original id.
`VID_T`	`getVerticesNum()`	Returns the number of vertices in this fragment.
`Class<? extends VID_T>`	`getVidClass()`
`boolean`	`gid2Vertex(VID_T gid, Vertex<VID_T> vertex)`
`boolean`	`innerVertexGid2Vertex(VID_T gid, Vertex<VID_T> vertex)`	Convert from global id to an inner vertex handle.
`VertexRange<VID_T>`	`innerVertices()`	Obtain vertex range contains all inner vertices.
`boolean`	`isInnerVertex(Vertex<VID_T> vertex)`	Check whether a vertex is a inner vertex for a fragment.
`boolean`	`isOuterVertex(Vertex<VID_T> vertex)`	Check whether a vertex is a outer vertex for a fragment.
`boolean`	`outerVertexGid2Vertex(VID_T gid, Vertex<VID_T> vertex)`	Convert from global id to an outer vertex handle.
`VertexRange<VID_T>`	`outerVertices()`	Obtain vertex range contains all outer vertices.
`void`	`setData(Vertex<VID_T> vertex, VDATA_T vdata)`	Update vertex data with a new value.
`VID_T`	`vertex2Gid(Vertex<VID_T> vertex)`
`VertexRange<VID_T>`	`vertices()`	Get all vertices referenced to this fragment.

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

- Field Detail
  - fragmentType
```
public static String fragmentType
```
- Constructor Detail
  - ImmutableEdgecutFragmentAdaptor
```
public ImmutableEdgecutFragmentAdaptor(ImmutableEdgecutFragment<OID_T,VID_T,VDATA_T,EDATA_T> frag,
                                       Class<? extends OID_T> oidClass,
                                       Class<? extends VID_T> vidClass,
                                       Class<? extends VDATA_T> vdataClass,
                                       Class<? extends EDATA_T> edataClass)
```
- Method Detail
  - getOidClass
```
public Class<? extends OID_T> getOidClass()
```
    Specified by:
    
    getOidClass in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getVidClass
```
public Class<? extends VID_T> getVidClass()
```
    Specified by:
    
    getVidClass in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getVdataClass
```
public Class<? extends VDATA_T> getVdataClass()
```
    Specified by:
    
    getVdataClass in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getEdataClass
```
public Class<? extends EDATA_T> getEdataClass()
```
    Specified by:
    
    getEdataClass in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getImmutableFragment
```
public ImmutableEdgecutFragment<OID_T,VID_T,VDATA_T,EDATA_T> getImmutableFragment()
```
  - fragmentType
```
public FragmentType fragmentType()
```
    Description copied from interface: IFragment
    
    Return the underlying fragment type,i.e. ArrowProjected or Simple.
    
    Specified by:
    
    fragmentType in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    underlying fragment type.
  - getFFIPointer
```
public com.alibaba.fastffi.FFIPointer getFFIPointer()
```
    Get the actual fragment FFIPointer we are using.
    
    Specified by:
    
    getFFIPointer in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    a ffipointer
  - fid
```
public int fid()
```
    Specified by:
    
    fid in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    The id of current fragment.
  - fnum
```
public int fnum()
```
    Description copied from interface: IFragment
    
    Number of fragments.
    
    Specified by:
    
    fnum in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    number of fragments.
  - getEdgeNum
```
public long getEdgeNum()
```
    Description copied from interface: IFragment
    
    Returns the number of edges in this fragment.
    
    Specified by:
    
    getEdgeNum in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    the number of edges in this fragment.
  - getInEdgeNum
```
public long getInEdgeNum()
```
    Specified by:
    
    getInEdgeNum in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getOutEdgeNum
```
public long getOutEdgeNum()
```
    Specified by:
    
    getOutEdgeNum in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getVerticesNum
```
public VID_T getVerticesNum()
```
    Description copied from interface: IFragment
    
    Returns the number of vertices in this fragment.
    
    Specified by:
    
    getVerticesNum in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    the number of vertices in this fragment.
  - getTotalVerticesNum
```
public long getTotalVerticesNum()
```
    Description copied from interface: IFragment
    
    Returns the number of vertices in the entire graph.
    
    Specified by:
    
    getTotalVerticesNum in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    The number of vertices in the entire graph.
  - vertices
```
public VertexRange<VID_T> vertices()
```
    Description copied from interface: IFragment
    
    Get all vertices referenced to this fragment.
    
    Specified by:
    
    vertices in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    A vertex set can be iterate on.
  - getVertex
```
public boolean getVertex(OID_T oid,
                         Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Get the vertex handle from the original id.
    
    Specified by:
    
    getVertex in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    oid - input original id.
    
    vertex - output vertex handle
    
    Returns:
    
    If find the vertex in this fragment, return true. Otherwise, return false.
  - getId
```
public OID_T getId(Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Get the original Id of a vertex.
    
    Specified by:
    
    getId in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - querying vertex.
    
    Returns:
    
    original id.
  - getFragId
```
public int getFragId(Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    To which fragment the vertex belongs.
    
    Specified by:
    
    getFragId in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - querying vertex.
    
    Returns:
    
    frag id.
  - getLocalInDegree
```
public int getLocalInDegree(Vertex<VID_T> vertex)
```
    Specified by:
    
    getLocalInDegree in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getLocalOutDegree
```
public int getLocalOutDegree(Vertex<VID_T> vertex)
```
    Specified by:
    
    getLocalOutDegree in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - gid2Vertex
```
public boolean gid2Vertex(VID_T gid,
                          Vertex<VID_T> vertex)
```
    Specified by:
    
    gid2Vertex in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - vertex2Gid
```
public VID_T vertex2Gid(Vertex<VID_T> vertex)
```
    Specified by:
    
    vertex2Gid in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getInnerVerticesNum
```
public long getInnerVerticesNum()
```
    Description copied from interface: IFragment
    
    Get the number of inner vertices.
    
    Specified by:
    
    getInnerVerticesNum in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    number of inner vertices.
  - getOuterVerticesNum
```
public long getOuterVerticesNum()
```
    Description copied from interface: IFragment
    
    Get the number of outer vertices.
    
    Specified by:
    
    getOuterVerticesNum in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    umber of outer vertices.
  - innerVertices
```
public VertexRange<VID_T> innerVertices()
```
    Description copied from interface: IFragment
    
    Obtain vertex range contains all inner vertices.
    
    Specified by:
    
    innerVertices in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    vertex range.
  - outerVertices
```
public VertexRange<VID_T> outerVertices()
```
    Description copied from interface: IFragment
    
    Obtain vertex range contains all outer vertices.
    
    Specified by:
    
    outerVertices in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Returns:
    
    vertex range.
  - isInnerVertex
```
public boolean isInnerVertex(Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Check whether a vertex is a inner vertex for a fragment.
    
    Specified by:
    
    isInnerVertex in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - querying vertex.
    
    Returns:
    
    true if is inner vertex.
  - isOuterVertex
```
public boolean isOuterVertex(Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Check whether a vertex is a outer vertex for a fragment.
    
    Specified by:
    
    isOuterVertex in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - querying vertex.
    
    Returns:
    
    true if is outer vertex.
  - getInnerVertex
```
public boolean getInnerVertex(OID_T oid,
                              Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Check whether a vertex, represented in OID_T, is a inner vertex. If yes, if true and put inner representation id in the second param. Else return false.
    
    Specified by:
    
    getInnerVertex in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    oid - querying vertex in OID_T.
    
    vertex - placeholder for VID_T, if oid belongs to this fragment.
    
    Returns:
    
    inner vertex or not.
  - getOuterVertex
```
public boolean getOuterVertex(OID_T oid,
                              Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Check whether a vertex, represented in OID_T, is a outer vertex. If yes, if true and put outer representation id in the second param. Else return false.
    
    Specified by:
    
    getOuterVertex in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    oid - querying vertex in OID_T.
    
    vertex - placeholder for VID_T, if oid doesn't belong to this fragment.
    
    Returns:
    
    outer vertex or not.
  - getInnerVertexId
```
public OID_T getInnerVertexId(Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Obtain vertex id from original id, only for inner vertex.
    
    Specified by:
    
    getInnerVertexId in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - querying vertex.
    
    Returns:
    
    original id.
  - getOuterVertexId
```
public OID_T getOuterVertexId(Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Obtain vertex id from original id, only for outer vertex.
    
    Specified by:
    
    getOuterVertexId in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - querying vertex.
    
    Returns:
    
    original id.
  - innerVertexGid2Vertex
```
public boolean innerVertexGid2Vertex(VID_T gid,
                                     Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Convert from global id to an inner vertex handle.
    
    Specified by:
    
    innerVertexGid2Vertex in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    gid - Input global id.
    
    vertex - Output vertex handle.
    
    Returns:
    
    True if exists an inner vertex of this fragment with global id as gid, false otherwise.
  - outerVertexGid2Vertex
```
public boolean outerVertexGid2Vertex(VID_T gid,
                                     Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Convert from global id to an outer vertex handle.
    
    Specified by:
    
    outerVertexGid2Vertex in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    gid - Input global id.
    
    vertex - Output vertex handle.
    
    Returns:
    
    True if exists an outer vertex of this fragment with global id as gid, false otherwise.
  - getOuterVertexGid
```
public VID_T getOuterVertexGid(Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Convert from inner vertex handle to its global id.
    
    Specified by:
    
    getOuterVertexGid in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - Input vertex handle.
    
    Returns:
    
    Global id of the vertex.
  - getInnerVertexGid
```
public VID_T getInnerVertexGid(Vertex<VID_T> vertex)
```
    Description copied from interface: IFragment
    
    Convert from outer vertex handle to its global id.
    
    Specified by:
    
    getInnerVertexGid in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - Input vertex handle.
    
    Returns:
    
    Global id of the vertex.
  - getIncomingAdjList
```
public AdjList<VID_T,EDATA_T> getIncomingAdjList(Vertex<VID_T> vertex)
```
    Specified by:
    
    getIncomingAdjList in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getOutgoingAdjList
```
public AdjList<VID_T,EDATA_T> getOutgoingAdjList(Vertex<VID_T> vertex)
```
    Specified by:
    
    getOutgoingAdjList in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
  - getData
```
public VDATA_T getData(Vertex<VID_T> vertex)
```
    Get the data on vertex.
    
    Specified by:
    
    getData in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - querying vertex.
    
    Returns:
    
    vertex data
  - setData
```
public void setData(Vertex<VID_T> vertex,
                    VDATA_T vdata)
```
    Update vertex data with a new value.
    
    Specified by:
    
    setData in interface IFragment<OID_T,VID_T,VDATA_T,EDATA_T>
    
    Parameters:
    
    vertex - querying vertex.
    
    vdata - new vertex data.

Class ImmutableEdgecutFragmentAdaptor<OID_T,​VID_T,​VDATA_T,​EDATA_T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fragmentType

Constructor Detail

ImmutableEdgecutFragmentAdaptor

Method Detail

getOidClass

getVidClass

getVdataClass

getEdataClass

getImmutableFragment

fragmentType

getFFIPointer

fid

fnum

getEdgeNum

getInEdgeNum

getOutEdgeNum

getVerticesNum

getTotalVerticesNum

vertices

getVertex

getId

getFragId

getLocalInDegree

getLocalOutDegree

gid2Vertex

vertex2Gid

getInnerVerticesNum

getOuterVerticesNum

innerVertices

outerVertices

isInnerVertex

isOuterVertex

getInnerVertex

getOuterVertex

getInnerVertexId

getOuterVertexId

innerVertexGid2Vertex

outerVertexGid2Vertex

getOuterVertexGid

getInnerVertexGid

getIncomingAdjList

getOutgoingAdjList

getData

setData

Class ImmutableEdgecutFragmentAdaptor<OID_T,VID_T,VDATA_T,EDATA_T>