org.ccsds.moims.mo.mal.MALElementsRegistry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-area001-v003-mal Show documentation
Show all versions of api-area001-v003-mal Show documentation
An implementation of the Java API for the CCSDS MAL
The newest version!
/* ----------------------------------------------------------------------------
* Copyright (C) 2023 European Space Agency
* European Space Operations Centre
* Darmstadt
* Germany
* ----------------------------------------------------------------------------
* System : CCSDS MO MAL Java API
* ----------------------------------------------------------------------------
* Licensed under the European Space Agency Public License, Version 2.0
* You may not use this file except in compliance with the License.
*
* Except as expressly set forth in this License, the Software is provided to
* You on an "as is" basis and without warranties of any kind, including without
* limitation merchantability, fitness for a particular purpose, absence of
* defects or errors, accuracy or non-infringement of intellectual property rights.
*
* See the License for the specific language governing permissions and
* limitations under the License.
* ----------------------------------------------------------------------------
*/
package org.ccsds.moims.mo.mal;
import java.util.HashMap;
import java.util.concurrent.Callable;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.ccsds.moims.mo.mal.structures.Element;
import org.ccsds.moims.mo.mal.structures.ElementList;
import org.ccsds.moims.mo.mal.structures.HeterogeneousList;
/**
* Holds a map of MAL Elements indexed on the absolute short form part. Used to
* lookup the correct elements for a supplied absolute short form part.
*/
public class MALElementsRegistry {
private final HashMap> ELEMENTS = new java.util.HashMap<>(128);
/**
* Adds an Element to the map of Elements.
*
* @param element The Element to be added.
* @return True if already previously loaded else false.
*/
public boolean addElement(Element element) {
Long typeId = element.getTypeId().getTypeId();
Callable callable = () -> element.createElement();
Callable previous = ELEMENTS.put(typeId, callable);
return previous != null; // Not the first time?
}
/**
* Removes an Element from the map of Elements.
*
* @param absoluteSFP The absolute short form part.
*/
public synchronized void removeCallableElement(Long absoluteSFP) {
ELEMENTS.remove(absoluteSFP);
}
/**
* Returns the number of elements available on the registry.
*
* @return The number of elements.
*/
public int howMany() {
return ELEMENTS.size();
}
/**
* Creates an element from the absolute short form part.
*
* @param typeIdLong The Type Id (aka: absolute short form part).
* @return The created Element.
* @throws NotFoundException if the element was not found.
*/
public Element createElement(Long typeIdLong) throws Exception {
if (typeIdLong == 0) {
return new HeterogeneousList();
}
Callable callable = ELEMENTS.get(typeIdLong);
if (callable == null) {
TypeId typeId = new TypeId(typeIdLong);
if (typeId.isOldMAL()) {
Logger.getLogger(MALElementsRegistry.class.getName()).log(Level.SEVERE,
"The typeId is using the old MAL version 1: {0}", typeId.toString());
}
throw new NotFoundException("The element was not found: "
+ typeIdLong + "(" + typeId.toString() + ")");
}
return callable.call();
}
/**
* Returns the list type of the supplied MAL element type.
*
* @param obj The MAL element type to return the list type of.
* @return The list type or null if not found or null passed in.
* @throws NotFoundException if the element could not be found.
*/
public static ElementList elementToElementList(Element obj) throws NotFoundException {
if (obj == null) {
return null;
}
// Is it already a List?
if (obj instanceof ElementList) {
return (ElementList) obj;
}
long l = obj.getTypeId().getSFP();
long ll = (-((l) & 0xFFFFFFL)) & 0xFFFFFFL + (l & 0xFFFFFFFFFF000000L);
try {
Element createdElement = MALContextFactory.getElementsRegistry().createElement(ll);
return (ElementList) createdElement;
} catch (Exception ex) {
throw new NotFoundException("The element could not be found in the MAL ElementFactory!"
+ " The object type is: " + obj.getClass().getSimpleName()
+ ". Maybe the service Helper for this object was not initialized."
+ " Try initializing the Service Helper of this object.", ex);
}
}
/**
* Returns the MAL element type of the supplied list type.
*
* @param obj The list type to return the MAL element type of.
* @return The MAL element type or null if not found or null passed in.
* @throws NotFoundException if the element could not be found.
*/
public static Element elementListToElement(ElementList obj) throws NotFoundException {
if (obj == null) {
return null;
}
long l = obj.getTypeId().getSFP();
long ll = (-((l) & 0xFFFFFFL)) & 0xFFFFFFL + (l & 0xFFFFFFFFFF000000L);
try {
return MALContextFactory.getElementsRegistry().createElement(ll);
} catch (Exception ex) {
throw new NotFoundException("The element could not be found in the MAL ElementFactory!"
+ " The object type is: " + obj.getClass().getSimpleName()
+ ". Maybe the service Helper for this object was not initialized."
+ " Try initializing the Service Helper of this object.", ex);
}
}
/**
* Registers the Elements for a certain area.
*
* @param malArea The Area with the Elements to be registered.
*/
public synchronized void registerElementsForArea(MALArea malArea) {
Element[] elements = malArea.getElements();
for (Element element : elements) {
if (this.addElement(element)) {
break;
}
}
}
/**
* Registers the Elements for a certain service.
*
* @param malService The Service with the Elements to be registered.
*/
public synchronized void registerElementsForService(ServiceInfo malService) {
Element[] elements = malService.getElements();
for (Element element : elements) {
if (this.addElement(element)) {
break;
}
}
}
/**
* Loads the Elements for a certain service and its respective Area.
*
* @param service The Service to be loaded.
*/
public void loadServiceAndAreaElements(ServiceInfo service) {
// Load the elements here:
this.registerElementsForArea(MALHelper.MAL_AREA);
this.registerElementsForService(service);
// The Top-level Area loading also needs to be loaded
this.registerElementsForArea(service.getArea());
try {
org.ccsds.moims.mo.mal.MALContextFactory.registerArea(service.getArea());
} catch (MALException ex) {
Logger.getLogger(MALElementsRegistry.class.getName()).log(
Level.SEVERE, "Something went wrong!", ex);
}
}
/**
* Loads the Area Elements and all the Service Elements in that Area.
*
* @param area The Area to be loaded.
*/
public void loadFullArea(MALArea area) {
for (ServiceInfo service : area.getServices()) {
loadServiceAndAreaElements(service);
}
}
}