TskGeoWaypointsUtil.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * Copyright 2020 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.datamodel.blackboardutils.attributes;

import com.google.gson.Gson;
import com.google.gson.annotations.SerializedName;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.blackboardutils.attributes.TskGeoWaypointsUtil.GeoWaypointList;
import org.sleuthkit.datamodel.blackboardutils.attributes.TskGeoWaypointsUtil.GeoWaypointList.GeoWaypoint;

public final class TskGeoWaypointsUtil implements BlackboardAttributeUtil<GeoWaypointList> {

        @Override
        public BlackboardAttribute toAttribute(String moduleName, GeoWaypointList value) {
                if (value == null) {
                        throw new IllegalArgumentException("toAttribute was pass a null list");
                }

                return new BlackboardAttribute(
                                BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_WAYPOINTS,
                                moduleName,
                                toJSON(value));
        }

        @Override
        public GeoWaypointList fromAttribute(BlackboardAttribute attribute) {
                if (attribute == null) {
                        throw new IllegalArgumentException("fromAttribute was pass a null list");
                }

                BlackboardAttribute.ATTRIBUTE_TYPE type = BlackboardAttribute.ATTRIBUTE_TYPE.fromID(attribute.getAttributeType().getTypeID());
                if (type != BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_WAYPOINTS) {
                        throw new IllegalArgumentException(String.format("Invalid attribute of type %s passed to fromAttribute method. Attribute of type TSK_GEO_WAYPOINTS is required", type.getDisplayName()));
                }

                return fromJSON(attribute.getValueString());
        }

        private static GeoWaypointList fromJSON(String json) {
                if (json == null || json.isEmpty()) {
                        return null;
                }

                return (new Gson()).fromJson(json, GeoWaypointList.class);
        }

        private static String toJSON(GeoWaypointList waypoints) {
                Gson gson = new Gson();
                return gson.toJson(waypoints);
        }

        public static final class GeoWaypointList implements Iterable<GeoWaypointList.GeoWaypoint> {

                private final List<GeoWaypoint> points;

                public GeoWaypointList() {
                        points = new ArrayList<>();
                }

                public void addPoint(GeoWaypoint wayPoint) {
                        if (wayPoint == null) {
                                throw new IllegalArgumentException("addPoint was passed a null waypoint");
                        }

                        points.add(wayPoint);
                }

                public boolean isEmpty() {
                        return points.isEmpty();
                }

                @Override
                public Iterator<GeoWaypointList.GeoWaypoint> iterator() {
                        return points.iterator();
                }

                public static class GeoWaypoint {

                        @SerializedName("TSK_GEO_LATITUDE")
                        private final Double latitude;
                        @SerializedName("TSK_GEO_LONGITUDE")
                        private final Double longitude;
                        @SerializedName("TSK_GEO_ALTITUDE")
                        private final Double altitude;
                        @SerializedName("TSK_NAME")
                        private final String name;

                        public GeoWaypoint(Double latitude, Double longitude, Double altitude, String name) {
                                if (latitude == null) {
                                        throw new IllegalArgumentException("Constructor was passed null latitude");
                                }

                                if (longitude == null) {
                                        throw new IllegalArgumentException("Constructor was passed null longitude");
                                }

                                this.latitude = latitude;
                                this.longitude = longitude;
                                this.altitude = altitude;
                                this.name = name;
                        }

                        public Double getLatitude() {
                                return latitude;
                        }

                        public Double getLongitude() {
                                return longitude;
                        }

                        public Double getAltitude() {
                                return altitude;
                        }

                        public String getName() {
                                return name;
                        }
                }
        }
}