File : data/Travel.js

/*

Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/

This  program is free software;

you can redistribute it and/or modify it under the terms of the

GNU General Public License as published by the Free Software Foundation;

either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program; if not, write to the Free Software

Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

*/

/*

Changes:

    - v4.0.0:

        - created from v3.6.0

Doc reviewed 202208

 */

import ObjId from '../data/ObjId.js';

import ObjType from '../data/ObjType.js';

import Collection from '../data/Collection.js';

import Route from '../data/Route.js';

import Note from '../data/Note.js';

import theHTMLSanitizer from '../core/htmlSanitizer/HTMLSanitizer.js';

import TravelObject from '../data/TravelObject.js';

import { INVALID_OBJ_ID } from '../main/Constants.js';

/* ------------------------------------------------------------------------------------------------------------------------- */

/**

This class represent a travel

*/

/* ------------------------------------------------------------------------------------------------------------------------- */

class Travel extends TravelObject {

    /**

    The object type for travels

    @type {ObjType}

    */

    static #objType = new ObjType ( 'Travel', [ 'editedRoute', 'routes', 'notes', 'layerName', 'name', 'readOnly', 'objId' ] );

    /**

    the route currently edited

    @type {Route}

    */

    #editedRoute = new Route ( );

    /**

    a Collection of Routes

    @type {Collection.<Route>}

    */

    #routes = new Collection ( Route );

    /**

    a Collection of Notes

    @type {Collection.<Note>}

    */

    #notes = new Collection ( Note );

    /**

    the background map name

    @type {String}

    */

    #layerName = 'OSM - Color';

    /**

    the Travel name

    @type {String}

    */

    #name = '';

    /**

    a boolean indicates when the Travel is read only

    @type {Boolean}

    */

    #readOnly = false;

    /**

    the objId of the travel

    @type {Number}

    */

    #objId = INVALID_OBJ_ID;

    /**

    The constructor

    */

    constructor ( ) {

        super ( );

        this.#routes.add ( new Route ( ) );

        this.#objId = ObjId.nextObjId;

    }

    /**

    the route currently edited

    @type {Route}

    */

    get editedRoute ( ) { return this.#editedRoute; }

    set editedRoute ( editedRoute ) {

        this.#editedRoute =

            'Route' === editedRoute?.objType?.name

                ?

                editedRoute

                :

                new Route ( );

    }

    /**

    a Collection of Routes

    @type {Collection.<Route>}

    */

    get routes ( ) { return this.#routes; }

    /**

    a Collection of Notes

    @type {Collection.<Note>}

    */

    get notes ( ) { return this.#notes; }

    /**

    the background map name

    @type {String}

    */

    get layerName ( ) { return this.#layerName; }

    set layerName ( layerName ) {

        this.#layerName =

            'string' === typeof ( layerName )

                ?

                theHTMLSanitizer.sanitizeToJsString ( layerName )

                :

                'OSM - Color';

    }

    /**

    the Travel name

    @type {String}

    */

    get name ( ) { return this.#name; }

    set name ( Name ) {

        this.#name =

            'string' === typeof ( Name )

                ?

                theHTMLSanitizer.sanitizeToJsString ( Name )

                :

                '';

    }

    /**

    a boolean indicates when the Travel is read only

    @type {Boolean}

    */

    get readOnly ( ) { return this.#readOnly; }

    set readOnly ( readOnly ) {

        this.#readOnly =

            'boolean' === typeof ( readOnly )

                ?

                readOnly

                :

                true;

    }

    /**

    the objId of the Travel. objId are unique identifier given by the code

    @type {Number}

    */

    get objId ( ) { return this.#objId; }

    /**

    the ObjType of the Travel.

    @type {ObjType}

    */

    get objType ( ) { return Travel.#objType; }

    /**

    An object literal with the Travel properties and without any methods.

    This object can be used with the JSON object

    @type {JsonObject}

    */

    get jsonObject ( ) {

        return {

            editedRoute : this.editedRoute.jsonObject,

            layerName : this.layerName,

            name : this.name,

            routes : this.routes.jsonObject,

            notes : this.notes.jsonObject,

            readOnly : this.readOnly,

            objId : this.#objId,

            objType : this.objType.jsonObject

        };

    }

    set jsonObject ( something ) {

        const otherthing = this.validateObject ( something );

        this.editedRoute.jsonObject = otherthing.editedRoute;

        this.layerName = something.layerName;

        this.name = otherthing.name;

        this.readOnly = otherthing.readOnly;

        this.routes.jsonObject = otherthing.routes;

        this.notes.jsonObject = otherthing.notes;

        this.#objId = ObjId.nextObjId;

    }

}

export default Travel;

/* --- End of file --------------------------------------------------------------------------------------------------------- */