src/rs/PlaceDisplayProperties.js - Code Metrics - Inspection of "SourceReference.descriptionId" - rootsdev/gedcomx-js - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 12c703...196755 )

by Justin

created 2016-10-21 15:37 UTC

src/rs/PlaceDisplayProperties.js A

↳ Parent: Project

Complexity

Total Complexity	14
Complexity/F	1.27

Size

Lines of Code	139
Function Count	11

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	0
c	1
b	0
f	0
nc	1
dl	0
loc	139
rs	10
wmc	14
mnd	1
bc	14
fnc	11
bpm	1.2727
cpm	1.2727
noi	3

module.exports = function(GedcomX){
  
  var utils = require('../utils'),
      Base = require('../Base');
  
  /**
   * A set of properties for convenience in displaying a summary of a place. 
   * 
   * @see {@link https://github.com/FamilySearch/gedcomx-rs/blob/master/specifications/rs-specification.md#place-display-properties-data-type|GEDCOM X RS Spec}
   * 
   * @class PlaceDisplayProperties
   * @extends Base
   * @param {Object} [json]

   */
  var PlaceDisplayProperties = function(json){
    
    // Protect against forgetting the new keyword when calling the constructor
    if(!(this instanceof PlaceDisplayProperties)){
      return new PlaceDisplayProperties(json);
    }
    
    // If the given object is already an instance then just return it. DON'T copy it.
    if(PlaceDisplayProperties.isInstance(json)){
      return json;
    }
    
    this.init(json);

  };
  
  PlaceDisplayProperties.prototype = Object.create(Base.prototype);
  
  PlaceDisplayProperties._gedxClass = PlaceDisplayProperties.prototype._gedxClass = 'GedcomX.PlaceDisplayProperties';
  
  PlaceDisplayProperties.jsonProps = [
    'name',
    'fullName',
    'type'
  ];
  
  /**
   * Check whether the given object is an instance of this class.
   * 
   * @param {Object} obj
   * @returns {Boolean}
   */
  PlaceDisplayProperties.isInstance = function(obj){
    return utils.isInstance(obj, this._gedxClass);
  };

  /**
   * Initialize from JSON
   * 
   * @param {Object}

   * @return {PlaceDisplayProperties} this
   */
  PlaceDisplayProperties.prototype.init = function(json){
    
    Base.prototype.init.call(this, json);
    
    if(json){
      this.setName(json.name);
      this.setFullName(json.fullName);
      this.setType(json.type);
    }
    return this;
  };
  
  /**
   * Set the name
   * 
   * @param {String} name
   * @return {PlaceDisplayProperties} this
   */
  PlaceDisplayProperties.prototype.setName = function(name){
    this.name = name;
    return this;
  };
  
  /**
   * Get the name
   * 
   * @return {String} name
   */
  PlaceDisplayProperties.prototype.getName = function(){
    return this.name;
  };
  
  /**
   * Set the full name
   * 
   * @param {String} fullName
   * @return {PlaceDisplayProperties} this
   */
  PlaceDisplayProperties.prototype.setFullName = function(fullName){
    this.fullName = fullName;
    return this;
  };
  
  /**
   * Get the full nname
   * 
   * @return {String} fullName
   */
  PlaceDisplayProperties.prototype.getFullName = function(){
    return this.fullName;
  };
  
  /**
   * Set the type
   * 
   * @param {String} type
   * @return {PlaceDisplayProperties} this
   */
  PlaceDisplayProperties.prototype.setType = function(type){
    this.type = type;
    return this;
  };
  
  /**
   * Get the type
   * 
   * @return {String} type
   */
  PlaceDisplayProperties.prototype.getType = function(){
    return this.type;
  };
  
  /**
   * Export the object as JSON
   * 
   * @return {Object} JSON object
   */
  PlaceDisplayProperties.prototype.toJSON = function(){
    return this._toJSON(Base, PlaceDisplayProperties.jsonProps);
  };
  
  GedcomX.PlaceDisplayProperties = PlaceDisplayProperties;
  
};

1			module.exports = function(GedcomX){
2
3			var utils = require('../utils'),
4			Base = require('../Base');
5
6			/**
7			* A set of properties for convenience in displaying a summary of a place.
8			*
9			* @see {@link https://github.com/FamilySearch/gedcomx-rs/blob/master/specifications/rs-specification.md#place-display-properties-data-type\|GEDCOM X RS Spec}
10			*
11			* @class PlaceDisplayProperties
12			* @extends Base
13			* @param {Object} [json]
			0 ignored issues – show Documentation introduced 2016-10-21 15:39 UTC by Report Bug Copy Issue Report The parameter `[json]` does not exist. Did you maybe forget to remove this comment? Loading history...
14			*/
15			var PlaceDisplayProperties = function(json){
16
17			// Protect against forgetting the new keyword when calling the constructor
18			if(!(this instanceof PlaceDisplayProperties)){
19			return new PlaceDisplayProperties(json);
20			}
21
22			// If the given object is already an instance then just return it. DON'T copy it.
23			if(PlaceDisplayProperties.isInstance(json)){
24			return json;
25			}
26
27			this.init(json);
			0 ignored issues – show Best Practice introduced 2016-10-21 15:39 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
28			};
29
30			PlaceDisplayProperties.prototype = Object.create(Base.prototype);
31
32			PlaceDisplayProperties._gedxClass = PlaceDisplayProperties.prototype._gedxClass = 'GedcomX.PlaceDisplayProperties';
33
34			PlaceDisplayProperties.jsonProps = [
35			'name',
36			'fullName',
37			'type'
38			];
39
40			/**
41			* Check whether the given object is an instance of this class.
42			*
43			* @param {Object} obj
44			* @returns {Boolean}
45			*/
46			PlaceDisplayProperties.isInstance = function(obj){
47			return utils.isInstance(obj, this._gedxClass);
48			};
49
50			/**
51			* Initialize from JSON
52			*
53			* @param {Object}
			0 ignored issues – show Documentation introduced 2016-10-21 15:39 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
54			* @return {PlaceDisplayProperties} this
55			*/
56			PlaceDisplayProperties.prototype.init = function(json){
57
58			Base.prototype.init.call(this, json);
59
60			if(json){
61			this.setName(json.name);
62			this.setFullName(json.fullName);
63			this.setType(json.type);
64			}
65			return this;
66			};
67
68			/**
69			* Set the name
70			*
71			* @param {String} name
72			* @return {PlaceDisplayProperties} this
73			*/
74			PlaceDisplayProperties.prototype.setName = function(name){
75			this.name = name;
76			return this;
77			};
78
79			/**
80			* Get the name
81			*
82			* @return {String} name
83			*/
84			PlaceDisplayProperties.prototype.getName = function(){
85			return this.name;
86			};
87
88			/**
89			* Set the full name
90			*
91			* @param {String} fullName
92			* @return {PlaceDisplayProperties} this
93			*/
94			PlaceDisplayProperties.prototype.setFullName = function(fullName){
95			this.fullName = fullName;
96			return this;
97			};
98
99			/**
100			* Get the full nname
101			*
102			* @return {String} fullName
103			*/
104			PlaceDisplayProperties.prototype.getFullName = function(){
105			return this.fullName;
106			};
107
108			/**
109			* Set the type
110			*
111			* @param {String} type
112			* @return {PlaceDisplayProperties} this
113			*/
114			PlaceDisplayProperties.prototype.setType = function(type){
115			this.type = type;
116			return this;
117			};
118
119			/**
120			* Get the type
121			*
122			* @return {String} type
123			*/
124			PlaceDisplayProperties.prototype.getType = function(){
125			return this.type;
126			};
127
128			/**
129			* Export the object as JSON
130			*
131			* @return {Object} JSON object
132			*/
133			PlaceDisplayProperties.prototype.toJSON = function(){
134			return this._toJSON(Base, PlaceDisplayProperties.jsonProps);
135			};
136
137			GedcomX.PlaceDisplayProperties = PlaceDisplayProperties;
138
139			};

rootsdev / gedcomx-js

Push — master ( 12c703...196755 )

src/rs/PlaceDisplayProperties.js A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like