org.yamcs.xtce.SequenceContainer Maven / Gradle / Ivy
package org.yamcs.xtce;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import static org.yamcs.xtce.AncillaryData.*;
/**
* A list of raw parameters, parameter segments, stream segments, containers, or container segments.
* Sequence containers may inherit from other sequence containers; when they do, the sequence in the parent
* SequenceContainer is 'inherited' and if the location of entries in the child sequence is not specified,
* it is assumed to start where the parent sequence ended. Parent sequence containers may be marked as "abstract".
* The idle pattern is part of any unallocated space in the Container.
*/
public class SequenceContainer extends Container {
private static final long serialVersionUID = 4L;
List entryList = new ArrayList<>();
public SequenceContainer(String name) {
super(name);
}
/**
* Use this container as a partition when archiving (name of the container is used as partitioning key in the tm
* table).
*
* If this property is set, this container name will be used for storing a certain packet if the packet doesn't
* match any inherited container with the property set
*
*/
private boolean useAsArchivePartition = false;
/**
* If this is true, the {@link #useAsArchivePartition} flag will be set automatically after all the MDB has been
* loaded.
*/
private boolean autoPartition = false;
@Override
public void addAncillaryData(AncillaryData data) {
super.addAncillaryData(data);
if (isArchivePartition(data)) {
this.useAsArchivePartition = true;
}
}
@Override
public void setAncillaryData(List ancillaryData) {
super.setAncillaryData(ancillaryData);
Optional o = ancillaryData.stream().filter(ad -> isArchivePartition(ad)).findAny();
if (o.isPresent()) {
this.useAsArchivePartition = true;
}
}
private boolean isArchivePartition(AncillaryData ad) {
return KEY_YAMCS.equalsIgnoreCase(ad.getName())
&& PROP_USE_AS_ARCHIVING_PARTITION.equalsIgnoreCase(ad.getValue());
}
public SequenceContainer getBaseContainer() {
return (SequenceContainer) baseContainer;
}
public void setBaseContainer(Container baseContainer) {
if (baseContainer instanceof SequenceContainer) {
this.baseContainer = (SequenceContainer) baseContainer;
} else {
throw new IllegalArgumentException("The SequenceContainer expects a SequenceContainer as base container");
}
}
public MatchCriteria getRestrictionCriteria() {
return restrictionCriteria;
}
/**
* Add single entry to list of entries
*
* @param entry
* Entry to be added
*/
public void addEntry(SequenceEntry entry) {
entryList.add(entry);
entry.setIndex(entryList.size() - 1);
entry.setContainer(this);
}
/**
* Insert the given entry in position idx. Shift all the subsequent entries to the right.
*
* @param idx
* @param entry
*/
public void insertEntry(int idx, SequenceEntry entry) {
entryList.add(idx, entry);
for (int i = idx; i < entryList.size(); i++) {
SequenceEntry se = entryList.get(i);
se.setIndex(i);
se.setContainer(this);
}
}
public void setEntryList(List entryList) {
this.entryList = entryList;
for (int i = 0; i < entryList.size(); i++) {
SequenceEntry entry = entryList.get(i);
entry.setIndex(i);
entry.setContainer(this);
}
}
/**
* Returns the list of the entries in the sequence container. The list is unmodifiable.
*/
public List getEntryList() {
return Collections.unmodifiableList(entryList);
}
public boolean useAsArchivePartition() {
return useAsArchivePartition;
}
/**
* If set to true, the XtceTmRecorder will set the qualified name of this container as the "pname" (packet
* name) column in the tm table. The packet will be then visible in the front page of Yamcs web as well as in the
* Archive overview.
*
* If the container has a child that matches the packet, and the child also has this flag set, then the name of the
* child will be used instead (e.g. the name of the most specific packet will be used).
*
* If no container having this flag matches a packet, the name of the root container will be used (even if it does
* not have the flag set).
*
* @param useAsArchivePartition
*/
public void useAsArchivePartition(boolean useAsArchivePartition) {
this.useAsArchivePartition = useAsArchivePartition;
if (ancillaryData != null) {
ancillaryData.removeIf(ad -> isArchivePartition(ad));
}
if (useAsArchivePartition) {
addAncillaryData(new AncillaryData(KEY_YAMCS, PROP_USE_AS_ARCHIVING_PARTITION));
}
}
public void print(PrintStream out) {
out.print("SequenceContainer name: " + name + ((sizeInBits > -1) ? ", sizeInBits: " + sizeInBits : ""));
if (getAliasSet() != null) {
out.print(", aliases: " + getAliasSet());
}
out.print(", useAsArchivePartition:" + useAsArchivePartition);
if (rate != null) {
out.print(", rateInStream: " + rate);
}
out.println();
if (baseContainer != null) {
out.print("\tbaseContainer: '" + baseContainer.getQualifiedName());
out.println("', restrictionCriteria: " + restrictionCriteria);
}
for (SequenceEntry se : getEntryList()) {
out.println("\t\t" + se);
}
}
@Override
public String toString() {
return "SequenceContainer(name=" + name + ")";
}
public boolean isAutoPartition() {
return autoPartition;
}
public void setAutoPartition(boolean autoPartition) {
this.autoPartition = autoPartition;
}
}