Apache GraphAr C++ Library
The C++ Library for Apache GraphAr
Public Member Functions | Friends | List of all members
graphar::PropertyGroup Class Reference

#include <graph_info.h>

Public Member Functions

 PropertyGroup (const std::vector< Property > &properties, FileType file_type, const std::string &prefix="")
 
const std::vector< Property > & GetProperties () const
 
bool HasProperty (const std::string &property_name) const
 
FileType GetFileType () const
 
const std::string & GetPrefix () const
 
bool IsValidated () const
 

Friends

std::ostream & operator<< (std::ostream &stream, const PropertyGroup &pg)
 

Detailed Description

PropertyGroup is a class to store the property group information.

A property group is a collection of properties with a file type and prefix used for chunk files. The prefix is optional and is the concatenation of property names with '_' as separator by default.

Definition at line 59 of file graph_info.h.

Constructor & Destructor Documentation

◆ PropertyGroup()

graphar::PropertyGroup::PropertyGroup ( const std::vector< Property > &  properties,
FileType  file_type,
const std::string &  prefix = "" 
)
explicit

Initialize the PropertyGroup with a list of properties, file type, and optional prefix.

Parameters
propertiesProperty list of the group
file_typeFile type of property group chunk file
prefixprefix of property group chunk file. The default prefix is the concatenation of property names with '_' as separator

Definition at line 92 of file graph_info.cc.

Member Function Documentation

◆ GetFileType()

FileType graphar::PropertyGroup::GetFileType ( ) const
inline

Get the file type of property group chunk file.

Returns
The file type of group.

Definition at line 86 of file graph_info.h.

◆ GetPrefix()

const std::string& graphar::PropertyGroup::GetPrefix ( ) const
inline

Get the prefix of property group chunk file.

Returns
The path prefix of group.

Definition at line 92 of file graph_info.h.

◆ GetProperties()

const std::vector< Property > & graphar::PropertyGroup::GetProperties ( ) const

Get the property list of group.

Returns
The property list of group.

Definition at line 103 of file graph_info.cc.

◆ IsValidated()

bool graphar::PropertyGroup::IsValidated ( ) const

Check if the property group is validated.

Definition at line 116 of file graph_info.cc.

The documentation for this class was generated from the following files: