added javadocs and comments
diff --git a/src/main/java/org.onosproject.xran/XranStore.java b/src/main/java/org.onosproject.xran/XranStore.java
index 00984b9..63a1a02 100644
--- a/src/main/java/org.onosproject.xran/XranStore.java
+++ b/src/main/java/org.onosproject.xran/XranStore.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2015-present Open Networking Laboratory
+ * Copyright 2015-present Open Networking Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,7 +20,6 @@
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.onosproject.store.Store;
import org.onosproject.xran.codecs.api.ECGI;
-import org.onosproject.xran.codecs.api.MMEUES1APID;
import org.onosproject.xran.controller.XranController;
import org.onosproject.xran.entities.RnibCell;
import org.onosproject.xran.entities.RnibLink;
@@ -37,65 +36,215 @@
// LINKS STORE
+ /**
+ * Get all active links.
+ *
+ * @return list of links
+ */
List<RnibLink> getLinks();
- List<RnibLink> getLinksByECGI(ECGI ecgi);
+ /**
+ * Get all links for that CELL based on ECGI.
+ *
+ * @param ecgi CELL ECGI
+ * @return list of links
+ */
+ List<RnibLink> getlinksbyecgi(ECGI ecgi);
- List<RnibLink> getLinksByCellId(String eciHex);
+ /**
+ * Get all links for that CELL based on ECI.
+ *
+ * @param eciHex HEX string of ECI
+ * @return list of links
+ */
+ List<RnibLink> getlinksbycellid(String eciHex);
- List<RnibLink> getLinksByUeId(long ueId);
+ /**
+ * Get all links for the UE based on UE ID.
+ *
+ * @param ueId UE ID
+ * @return list of links
+ */
+ List<RnibLink> getlinksbyueid(long ueId);
- RnibLink getLinkBetweenCellIdUeId(String cellId, long ueId);
+ /**
+ * Get a link between a CELL and UE.
+ *
+ * @param cellId HEX string ECI
+ * @param ueId UE id
+ * @return link
+ */
+ RnibLink getlinkbetweencellidueid(String cellId, long ueId);
+ /**
+ * Get a link between a CELL's ECGI and UE's id.
+ *
+ * @param ecgi CELL ECGI
+ * @param ueId UE id
+ * @return link
+ */
RnibLink getLink(ECGI ecgi, Long ueId);
- void modifyLinkRrmConf(RnibLink link, JsonNode rrmConf);
+ /**
+ * Modify specified link's RRM Configuration.
+ *
+ * @param link LINK entity
+ * @param rrmConf json node of RRM Configuration
+ */
+ void modifylinkrrmconf(RnibLink link, JsonNode rrmConf);
+ /**
+ * Put new link to store.
+ *
+ * @param link LINK entity
+ */
void storeLink(RnibLink link);
+ /**
+ * Remove link from store.
+ *
+ * @param link LINK entity
+ * @return true if remove succeeded
+ */
boolean removeLink(LinkId link);
// NODES
+ /**
+ * Get all CELLs and UEs.
+ *
+ * @return list of UEs and CELLs
+ */
List<Object> getNodes();
- List<Object> getCellNodes();
+ /**
+ * Get all CELLs.
+ *
+ * @return list of CELLs
+ */
+ List<Object> getcellnodes();
- List<Object> getUeNodes();
+ /**
+ * Get all UEs.
+ *
+ * @return list of UEs
+ */
+ List<Object> getuenodes();
- Object getByNodeId(String nodeId);
+ /**
+ * Get node by node id.
+ *
+ * @param nodeId HEX string ECI or UE id
+ * @return CELL or UE
+ */
+ Object getbynodeid(String nodeId);
// CELL
+ /**
+ * Get cell based on HEX string ECI.
+ *
+ * @param eci HEX string ECI
+ * @return CELL if found
+ */
RnibCell getCell(String eci);
+ /**
+ * Get cell based on ECGI.
+ *
+ * @param cellId CELL ECGI
+ * @return CELL if found
+ */
RnibCell getCell(ECGI cellId);
- void modifyCellRrmConf(RnibCell cell, JsonNode rrmConf) throws Exception;
+ /**
+ * Modify CELL's RRM Configuration.
+ *
+ * @param cell CELL entity
+ * @param rrmConf json node of RRM Configuration
+ * @throws Exception exception
+ */
+ void modifycellrrmconf(RnibCell cell, JsonNode rrmConf) throws Exception;
+ /**
+ * Put new CELL to the store.
+ *
+ * @param cell CELL entity
+ */
void storeCell(RnibCell cell);
+ /**
+ * Remove CELL from the store.
+ *
+ * @param ecgi CELL's ECGI
+ * @return ture if remove succeeded
+ */
boolean removeCell(ECGI ecgi);
// SLICE
+ /**
+ * Get SLICE based on SLICE id.
+ *
+ * @param sliceId SLICE id
+ * @return SLICE
+ */
RnibSlice getSlice(long sliceId);
+ /**
+ * Put new SLICE to the store.
+ *
+ * @param attributes json node of SLICE attributes
+ * @return true if put succeeded
+ */
boolean createSlice(ObjectNode attributes);
+ /**
+ * Remove SLICE based on SLICE id.
+ *
+ * @param sliceId SLICE id
+ * @return true if remove succeeded
+ */
boolean removeCell(long sliceId);
// CONTROLLER
+ /**
+ * Get the xran controller instance.
+ *
+ * @return xran controller
+ */
XranController getController();
+ /**
+ * Set the xran controller instance.
+ *
+ * @param controller xran controller
+ */
void setController(XranController controller);
// UE
+ /**
+ * Get UE based on UE id.
+ *
+ * @param euId UE id
+ * @return UE entity
+ */
RnibUe getUe(long euId);
+ /**
+ * Put new UE to store.
+ *
+ * @param ue UE entity
+ */
void storeUe(RnibUe ue);
+ /**
+ * Remove UE from store.
+ *
+ * @param ueId UE id
+ * @return true if remove succeeded
+ */
boolean removeUe(long ueId);
}