Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve some comments #472

Merged
merged 1 commit into from
Apr 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -129,13 +129,13 @@ public List<Shard> getSplits(long splitPartitions, long splitSize) {
/**
* Get splits of a table in specified range
* NOTE: maybe we don't need this method
* @param start, end: the specified range
* @param start: the start of range
* @param end: the end of range
* @param splitPartitions: expected partitions count per split
* @param splitSize: expected size(bytes) per split,
* splitPartitions will be ignored if splitSize is passed
* @return a list of Shard
*/

public List<Shard> getSplits(String start, String end,
int splitPartitions, int splitSize) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,6 @@ public EventHub indexEventHub() {
return this.indexEventHub;
}

/**
* @SuppressWarnings("UnstableApiUsage")
*/
public RateLimiter rateLimiter() {
return this.rateLimiter;
}
Expand Down Expand Up @@ -574,8 +571,7 @@ public Id[] mapVlName2Id(String[] vertexLabels) {

/**
* Stop all the daemon threads
* @param timout seconds
* @throws InterruptedException when be interrupted
* @param timeout seconds
*/
public static void shutdown(long timeout) {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public final class IdHolder {

/**
* For non-paging situation
* @param ids all ids
*/
public IdHolder(Set<Id> ids) {
this.query = null;
Expand All @@ -52,6 +53,8 @@ public IdHolder(Set<Id> ids) {

/**
* For paging situation
* @param query original query
* @param idsFetcher function to fetch one page ids
*/
public IdHolder(ConditionQuery query,
Function<ConditionQuery, PageIds> idsFetcher) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ public void updateEdgeIndex(HugeEdge edge, boolean removed) {

/**
* Update index(user properties) of vertex or edge
* @param ilId the id of index label
* @param element the properties owner
* @param removed remove or add index
*/
protected void updateIndex(Id ilId, HugeElement element, boolean removed) {
SchemaTransaction schema = graph().schemaTransaction();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ protected static void removeIndexLabelFromBaseLabel(SchemaTransaction tx,
/**
* Use reflection to call SchemaTransaction.removeSchema(),
* which is protected
* @param tx The remove operation actual executer
* @param schema the schema to be removed
*/
protected static void removeSchema(SchemaTransaction tx,
SchemaElement schema) {
Expand All @@ -86,6 +88,8 @@ protected static void removeSchema(SchemaTransaction tx,
/**
* Use reflection to call SchemaTransaction.updateSchema(),
* which is protected
* @param tx The update operation actual executer
* @param schema the schema to be update
*/
protected static void updateSchema(SchemaTransaction tx,
SchemaElement schema) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ public Class<?> clazz() {
/**
* Check type of the value valid
* @param value the property value to be checked data type
* @param <V> the property value original data type
* @return true if the value is or can convert to the data type,
* otherwise false
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public int test(String[] args) throws Exception {

/**
* Multi-threaded and multi-commits and batch insertion test
* @param graph
* @param graph graph
* @param threadCount
* The count of threads that perform the insert operation at the
* same time
Expand All @@ -98,7 +98,7 @@ public int test(String[] args) throws Exception {
* @param multiple
* The coefficient to multiple number of vertices(100) and edges(100)
* for each transaction commit
* @throws InterruptedException
* @throws Exception execute may throw Exception
*/
public void testInsertPerf(GraphManager graph,
int threadCount,
Expand Down