Class: Reference

Inherits:
Object
  • Object
show all
Defined in:
lib/refworks/reference.rb

Overview

noinspection RubyTooManyInstanceVariablesInspection,RubyTooManyMethodsInspection

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rawref) ⇒ Reference

expecting a HTTParty-parsed RWResult reference hash to be passed in



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/refworks/reference.rb', line 17

def initialize(rawref)

  # Basically, creating an empty ref.  For instance, if you want to
  # hand-construct the reference one field at a time.
  unless rawref["rt"]
    return
  end

  # using Mash so I can use symbols as keys instead of strings, which is what
  # is returned from httparty
  ref = Mash.new(rawref)

  # Here I populate attributes which correspond to RefWorks Tagged Format.
  # See: http://www.refworks.com/rwathens/help/RefWorks_Tagged_Format.htm
  # for more details.  The tag list is in a comment at the end of this file.

  @rt = ref[:rt]

  # the next two are my own extensions, not part of the RefWorks tagged format.
  # They are a decomposition of the rt complex value which I think is useful.
  @rt_num = ref[:rt][:typeOrd]
  @rt_string = ref[:rt][:__content__]

  @sr = ref[:sr]

  @id = ref[:id][0]

  # HTTParty will produce either a string or an array when it converts the XML response
  # to a Ruby data structure.  Which one it produces depends upon how
  # many authors there are.  All values are converted to Arrays, even one item
  # values, for consistency.  I do this for any field which can have more than one value.
  # To accomplish this, I provide custom setters instead of the auto-generated setters
  # that are created via attr_accessor.  This affects a1-a6 plus k1 attributes.
  self.a1=(ref[:a1])

  @t1 = ref[:t1]

  @jf = ref[:jf]
  @jo = ref[:jo]
  @yr = ref[:yr]
  @fd = ref[:fd]
  @vo = ref[:vo]
  @is = ref[:is]
  @sp = ref[:sp]
  @op = ref[:op]

  if ref[:k1]
    self.k1=(ref[:k1])
  end

  @ab = ref[:ab]
  @no = ref[:no]

  if ref[:a2]
    self.a2=(ref[:a2])
  end

  @t2 = ref[:t2]

  @ed = ref[:ed]
  @pb = ref[:pb]
  @pp = ref[:pp]

  if ref[:a3]
    self.a3=(ref[:a3])
  end

  if ref[:a4]
    self.a4=(ref[:a4])
  end

  if ref[:a5]
    self.a5=(ref[:a5])
  end

  @t3 = ref[:t3]
  @sn = ref[:sn]
  @av = ref[:av]
  @ad = ref[:ad]
  @an = ref[:an]
  @la = ref[:la]
  @cl = ref[:cl]
  @sf = ref[:sf]
  @ot = ref[:ot]
  @lk = ref[:lk]
  @do = ref[:do]
  @cn = ref[:cn]
  @db = ref[:db]
  @ds = ref[:ds]
  @ip = ref[:ip]
  @rd = ref[:rd]
  @st = ref[:st]
  @u1 = ref[:u1]
  @u2 = ref[:u2]
  @u3 = ref[:u3]
  @u4 = ref[:u4]
  @u5 = ref[:u5]
  @u6 = ref[:u6]
  @u7 = ref[:u7]
  @u8 = ref[:u8]
  @u9 = ref[:u9]
  @u10 = ref[:u10]
  @u11 = ref[:u11]
  @u12 = ref[:u12]
  @u13 = ref[:u13]
  @u14 = ref[:u14]
  @u15 = ref[:u15]
  @ul = ref[:ul]
  @sl = ref[:sl]
  @ll = ref[:ll]
  @cr = ref[:cr]
  @wt = ref[:wt]

  if ref[:a6]
    self.a6=(ref[:a6])
  end

  @wv = ref[:wv]
  @wp = ref[:wp]
  @ol = ref[:ol]
  @pmid = ref[:pmid]
  @pmcid = ref[:pmcid]

  # Not documented as part of the RefWorks tagged format, but the API returns these fields
  @fl = ref[:fl]
  @cd = ref[:cd]
  @md = ref[:md]
end

Instance Attribute Details

#a1 ⇒ Object

the following need special setter behavior (custom setters below) so they only get standard readers



14
15
16
 
# File 'lib/refworks/reference.rb', line 14

def a1
  @a1
end

#a2 ⇒ Object

the following need special setter behavior (custom setters below) so they only get standard readers



14
15
16
 
# File 'lib/refworks/reference.rb', line 14

def a2
  @a2
end

#a3 ⇒ Object

the following need special setter behavior (custom setters below) so they only get standard readers



14
15
16
 
# File 'lib/refworks/reference.rb', line 14

def a3
  @a3
end

#a4 ⇒ Object

the following need special setter behavior (custom setters below) so they only get standard readers



14
15
16
 
# File 'lib/refworks/reference.rb', line 14

def a4
  @a4
end

#a5 ⇒ Object

the following need special setter behavior (custom setters below) so they only get standard readers



14
15
16
 
# File 'lib/refworks/reference.rb', line 14

def a5
  @a5
end

#a6 ⇒ Object

the following need special setter behavior (custom setters below) so they only get standard readers



14
15
16
 
# File 'lib/refworks/reference.rb', line 14

def a6
  @a6
end

#ab ⇒ Object

Returns the value of attribute ab.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ab
  @ab
end

#ad ⇒ Object

Returns the value of attribute ad.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ad
  @ad
end

#an ⇒ Object

Returns the value of attribute an.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def an
  @an
end

#av ⇒ Object

Returns the value of attribute av.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def av
  @av
end

#cd ⇒ Object

Returns the value of attribute cd.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def cd
  @cd
end

#cl ⇒ Object

Returns the value of attribute cl.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def cl
  @cl
end

#cn ⇒ Object

Returns the value of attribute cn.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def cn
  @cn
end

#cr ⇒ Object

Returns the value of attribute cr.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def cr
  @cr
end

#db ⇒ Object

Returns the value of attribute db.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def db
  @db
end

#do ⇒ Object

Returns the value of attribute do.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def do
  @do
end

#ds ⇒ Object

Returns the value of attribute ds.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ds
  @ds
end

#ed ⇒ Object

Returns the value of attribute ed.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ed
  @ed
end

#fd ⇒ Object

Returns the value of attribute fd.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def fd
  @fd
end

#fl ⇒ Object

Returns the value of attribute fl.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def fl
  @fl
end

#id ⇒ Object

Returns the value of attribute id.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def id
  @id
end

#ip ⇒ Object

Returns the value of attribute ip.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ip
  @ip
end

#is ⇒ Object

Returns the value of attribute is.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def is
  @is
end

#jf ⇒ Object

Returns the value of attribute jf.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def jf
  @jf
end

#jo ⇒ Object

Returns the value of attribute jo.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def jo
  @jo
end

#k1 ⇒ Object

the following need special setter behavior (custom setters below) so they only get standard readers



14
15
16
 
# File 'lib/refworks/reference.rb', line 14

def k1
  @k1
end

#la ⇒ Object

Returns the value of attribute la.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def la
  @la
end

#lk ⇒ Object

Returns the value of attribute lk.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def lk
  @lk
end

#ll ⇒ Object

Returns the value of attribute ll.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ll
  @ll
end

#md ⇒ Object

Returns the value of attribute md.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def md
  @md
end

#no ⇒ Object

Returns the value of attribute no.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def no
  @no
end

#ol ⇒ Object

Returns the value of attribute ol.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ol
  @ol
end

#op ⇒ Object

Returns the value of attribute op.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def op
  @op
end

#ot ⇒ Object

Returns the value of attribute ot.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ot
  @ot
end

#pb ⇒ Object

Returns the value of attribute pb.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def pb
  @pb
end

#pmcid ⇒ Object

Returns the value of attribute pmcid.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def pmcid
  @pmcid
end

#pmid ⇒ Object

Returns the value of attribute pmid.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def pmid
  @pmid
end

#pp ⇒ Object

Returns the value of attribute pp.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def pp
  @pp
end

#rd ⇒ Object

Returns the value of attribute rd.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def rd
  @rd
end

#rt ⇒ Object

Returns the value of attribute rt.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def rt
  @rt
end

#rt_num ⇒ Object

Returns the value of attribute rt_num.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def rt_num
  @rt_num
end

#rt_string ⇒ Object

Returns the value of attribute rt_string.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def rt_string
  @rt_string
end

#sf ⇒ Object

Returns the value of attribute sf.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def sf
  @sf
end

#sl ⇒ Object

Returns the value of attribute sl.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def sl
  @sl
end

#sn ⇒ Object

Returns the value of attribute sn.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def sn
  @sn
end

#sp ⇒ Object

Returns the value of attribute sp.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def sp
  @sp
end

#sr ⇒ Object

Returns the value of attribute sr.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def sr
  @sr
end

#st ⇒ Object

Returns the value of attribute st.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def st
  @st
end

#t1 ⇒ Object

Returns the value of attribute t1.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def t1
  @t1
end

#t2 ⇒ Object

Returns the value of attribute t2.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def t2
  @t2
end

#t3 ⇒ Object

Returns the value of attribute t3.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def t3
  @t3
end

#u1 ⇒ Object

Returns the value of attribute u1.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u1
  @u1
end

#u10 ⇒ Object

Returns the value of attribute u10.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u10
  @u10
end

#u11 ⇒ Object

Returns the value of attribute u11.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u11
  @u11
end

#u12 ⇒ Object

Returns the value of attribute u12.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u12
  @u12
end

#u13 ⇒ Object

Returns the value of attribute u13.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u13
  @u13
end

#u14 ⇒ Object

Returns the value of attribute u14.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u14
  @u14
end

#u15 ⇒ Object

Returns the value of attribute u15.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u15
  @u15
end

#u2 ⇒ Object

Returns the value of attribute u2.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u2
  @u2
end

#u3 ⇒ Object

Returns the value of attribute u3.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u3
  @u3
end

#u4 ⇒ Object

Returns the value of attribute u4.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u4
  @u4
end

#u5 ⇒ Object

Returns the value of attribute u5.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u5
  @u5
end

#u6 ⇒ Object

Returns the value of attribute u6.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u6
  @u6
end

#u7 ⇒ Object

Returns the value of attribute u7.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u7
  @u7
end

#u8 ⇒ Object

Returns the value of attribute u8.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u8
  @u8
end

#u9 ⇒ Object

Returns the value of attribute u9.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def u9
  @u9
end

#ul ⇒ Object

Returns the value of attribute ul.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def ul
  @ul
end

#vo ⇒ Object

Returns the value of attribute vo.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def vo
  @vo
end

#wp ⇒ Object

Returns the value of attribute wp.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def wp
  @wp
end

#wt ⇒ Object

Returns the value of attribute wt.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def wt
  @wt
end

#wv ⇒ Object

Returns the value of attribute wv.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def wv
  @wv
end

#yr ⇒ Object

Returns the value of attribute yr.



6
7
8
 
# File 'lib/refworks/reference.rb', line 6

def yr
  @yr
end

Instance Method Details

#abstract ⇒ Object 



410
411
412
 
# File 'lib/refworks/reference.rb', line 410

def abstract
  ab
end

#abstract=(val) ⇒ Object 



414
415
416
 
# File 'lib/refworks/reference.rb', line 414

def abstract=(val)
  self.ab=val
end

#accession_number ⇒ Object 



522
523
524
 
# File 'lib/refworks/reference.rb', line 522

def accession_number
  an
end

#accession_number=(val) ⇒ Object 



526
527
528
 
# File 'lib/refworks/reference.rb', line 526

def accession_number=(val)
  self.an=val
end

#author_address ⇒ Object 



514
515
516
 
# File 'lib/refworks/reference.rb', line 514

def author_address
  ad
end

#author_address=(val) ⇒ Object 



518
519
520
 
# File 'lib/refworks/reference.rb', line 518

def author_address=(val)
  self.ad=val
end

#availability ⇒ Object 



506
507
508
 
# File 'lib/refworks/reference.rb', line 506

def availability
  av
end

#availability=(val) ⇒ Object 



510
511
512
 
# File 'lib/refworks/reference.rb', line 510

def availability=(val)
  self.av=val
end

#call_number ⇒ Object 



592
593
594
 
# File 'lib/refworks/reference.rb', line 592

def call_number
  cn
end

#call_number=(val) ⇒ Object 



596
597
598
 
# File 'lib/refworks/reference.rb', line 596

def call_number=(val)
  self.cn=val
end

#cited_references ⇒ Object 



784
785
786
 
# File 'lib/refworks/reference.rb', line 784

def cited_references
  cr
end

#cited_references=(val) ⇒ Object 



788
789
790
 
# File 'lib/refworks/reference.rb', line 788

def cited_references=(val)
  self.cr=val
end

#classification ⇒ Object 



538
539
540
 
# File 'lib/refworks/reference.rb', line 538

def classification
  cl
end

#classification=(val) ⇒ Object 



542
543
544
 
# File 'lib/refworks/reference.rb', line 542

def classification=(val)
  self.cl=val
end

#created_date ⇒ Object

extension



838
839
840
 
# File 'lib/refworks/reference.rb', line 838

def created_date
  cd
end

#data_source ⇒ Object 



608
609
610
 
# File 'lib/refworks/reference.rb', line 608

def data_source
  ds
end

#data_source=(val) ⇒ Object 



612
613
614
 
# File 'lib/refworks/reference.rb', line 612

def data_source=(val)
  self.ds=val
end

#database ⇒ Object 



600
601
602
 
# File 'lib/refworks/reference.rb', line 600

def database
  db
end

#database=(val) ⇒ Object 



604
605
606
 
# File 'lib/refworks/reference.rb', line 604

def database=(val)
  self.db=val
end

#date_of_electronic_publication ⇒ Object 



816
817
818
 
# File 'lib/refworks/reference.rb', line 816

def date_of_electronic_publication
  wp
end

#date_of_electronic_publication=(val) ⇒ Object 



820
821
822
 
# File 'lib/refworks/reference.rb', line 820

def date_of_electronic_publication=(val)
  self.wp=val
end

#digital_object_identifier ⇒ Object 



570
571
572
573
 
# File 'lib/refworks/reference.rb', line 570

def digital_object_identifier
  # @ sign to avoid collision with Ruby keyword 'do'
  @do
end

#digital_object_identifier=(val) ⇒ Object 



575
576
577
578
 
# File 'lib/refworks/reference.rb', line 575

def digital_object_identifier=(val)
  # @ sign to avoid collision with Ruby keyword 'do'
  @do=val
end

#doi ⇒ Object

alias



581
582
583
584
 
# File 'lib/refworks/reference.rb', line 581

def doi
  # @ sign to avoid collision with Ruby keyword 'do'
  @do
end

#doi=(val) ⇒ Object

alias



587
588
589
590
 
# File 'lib/refworks/reference.rb', line 587

def doi=(val)
  # @ sign to avoid collision with Ruby keyword 'do'
  @do=val
end

#edition ⇒ Object 



442
443
444
 
# File 'lib/refworks/reference.rb', line 442

def edition
  ed
end

#edition=(val) ⇒ Object 



446
447
448
 
# File 'lib/refworks/reference.rb', line 446

def edition=(val)
  self.ed=val
end

#folder ⇒ Object

extension



833
834
835
 
# File 'lib/refworks/reference.rb', line 833

def folder
  fl
end

#identifying_phrase ⇒ Object 



616
617
618
 
# File 'lib/refworks/reference.rb', line 616

def identifying_phrase
  ip
end

#identifying_phrase=(val) ⇒ Object 



620
621
622
 
# File 'lib/refworks/reference.rb', line 620

def identifying_phrase=(val)
  self.ip=val
end

#issn_isbn ⇒ Object 



498
499
500
 
# File 'lib/refworks/reference.rb', line 498

def issn_isbn
  sn
end

#issn_isbn=(val) ⇒ Object 



502
503
504
 
# File 'lib/refworks/reference.rb', line 502

def issn_isbn=(val)
  self.sn=val
end

#issue ⇒ Object 



370
371
372
 
# File 'lib/refworks/reference.rb', line 370

def issue
  is
end

#issue=(val) ⇒ Object 



374
375
376
 
# File 'lib/refworks/reference.rb', line 374

def issue=(val)
  self.is=val
end

#keyword ⇒ Object 



394
395
396
 
# File 'lib/refworks/reference.rb', line 394

def keyword
  k1
end

#keyword=(val) ⇒ Object 



398
399
400
 
# File 'lib/refworks/reference.rb', line 398

def keyword=(val)
  self.k1 = val
end

#keywords ⇒ Object 



402
403
404
 
# File 'lib/refworks/reference.rb', line 402

def keywords
  k1
end

#keywords=(val) ⇒ Object 



406
407
408
 
# File 'lib/refworks/reference.rb', line 406

def keywords=(val)
  self.k1 = val
end

#language ⇒ Object 



530
531
532
 
# File 'lib/refworks/reference.rb', line 530

def language
  la
end

#language=(val) ⇒ Object 



534
535
536
 
# File 'lib/refworks/reference.rb', line 534

def language=(val)
  self.la=val
end

#links ⇒ Object 



562
563
564
 
# File 'lib/refworks/reference.rb', line 562

def links
  lk
end

#links=(val) ⇒ Object 



566
567
568
 
# File 'lib/refworks/reference.rb', line 566

def links=(val)
  self.lk=val
end

#modified_date ⇒ Object

extension



843
844
845
 
# File 'lib/refworks/reference.rb', line 843

def modified_date
  md
end

#notes ⇒ Object 



418
419
420
 
# File 'lib/refworks/reference.rb', line 418

def notes
  no
end

#notes=(val) ⇒ Object 



422
423
424
 
# File 'lib/refworks/reference.rb', line 422

def notes=(val)
  self.no=val
end

#original_foreign_title ⇒ Object 



554
555
556
 
# File 'lib/refworks/reference.rb', line 554

def original_foreign_title
  ot
end

#original_foreign_title=(val) ⇒ Object 



558
559
560
 
# File 'lib/refworks/reference.rb', line 558

def original_foreign_title=(val)
  self.ot=val
end

#other_pages ⇒ Object 



386
387
388
 
# File 'lib/refworks/reference.rb', line 386

def other_pages
  op
end

#other_pages=(val) ⇒ Object 



390
391
392
 
# File 'lib/refworks/reference.rb', line 390

def other_pages=(val)
  self.op=val
end

#output_language ⇒ Object 



824
825
826
 
# File 'lib/refworks/reference.rb', line 824

def output_language
  ol
end

#output_language=(val) ⇒ Object 



828
829
830
 
# File 'lib/refworks/reference.rb', line 828

def output_language=(val)
  self.ol=val
end

#periodical_abbrev ⇒ Object 



338
339
340
 
# File 'lib/refworks/reference.rb', line 338

def periodical_abbrev
  jo
end

#periodical_abbrev=(val) ⇒ Object 



342
343
344
 
# File 'lib/refworks/reference.rb', line 342

def periodical_abbrev=(val)
  self.jo=val
end

#periodical_full ⇒ Object 



330
331
332
 
# File 'lib/refworks/reference.rb', line 330

def periodical_full
  jf
end

#periodical_full=(val) ⇒ Object 



334
335
336
 
# File 'lib/refworks/reference.rb', line 334

def periodical_full=(val)
  self.jf=val
end

#place_of_publication ⇒ Object 



458
459
460
 
# File 'lib/refworks/reference.rb', line 458

def place_of_publication
  pp
end

#place_of_publication=(val) ⇒ Object 



462
463
464
 
# File 'lib/refworks/reference.rb', line 462

def place_of_publication=(val)
  self.pp=val
end

#primary_authors ⇒ Object Also known as: authors 



292
293
294
 
# File 'lib/refworks/reference.rb', line 292

def primary_authors
  a1
end

#primary_authors=(val) ⇒ Object Also known as: authors= 



296
297
298
 
# File 'lib/refworks/reference.rb', line 296

def primary_authors=(val)
  self.a1 = val
end

#primary_title ⇒ Object

# alias def authors=(val)

self.a1

end



313
314
315
 
# File 'lib/refworks/reference.rb', line 313

def primary_title
  t1
end

#primary_title=(val) ⇒ Object 



317
318
319
 
# File 'lib/refworks/reference.rb', line 317

def primary_title=(val)
  self.t1 = val
end

#publication_data_free_form ⇒ Object 



354
355
356
 
# File 'lib/refworks/reference.rb', line 354

def publication_data_free_form
  fd
end

#publication_data_free_form=(val) ⇒ Object 



358
359
360
 
# File 'lib/refworks/reference.rb', line 358

def publication_data_free_form=(val)
  self.fd=val
end

#publication_year ⇒ Object 



346
347
348
 
# File 'lib/refworks/reference.rb', line 346

def publication_year
  yr
end

#publication_year=(val) ⇒ Object 



350
351
352
 
# File 'lib/refworks/reference.rb', line 350

def publication_year=(val)
  self.yr=val
end

#publisher ⇒ Object 



450
451
452
 
# File 'lib/refworks/reference.rb', line 450

def publisher
  pb
end

#publisher=(val) ⇒ Object 



454
455
456
 
# File 'lib/refworks/reference.rb', line 454

def publisher=(val)
  self.pb=val
end

#quaternary_authors ⇒ Object 



474
475
476
 
# File 'lib/refworks/reference.rb', line 474

def quaternary_authors
  a4
end

#quaternary_authors=(val) ⇒ Object 



478
479
480
 
# File 'lib/refworks/reference.rb', line 478

def quaternary_authors=(val)
  self.a4= val
end

#quinary_authors ⇒ Object 



482
483
484
 
# File 'lib/refworks/reference.rb', line 482

def quinary_authors
  a5
end

#quinary_authors=(val) ⇒ Object 



486
487
488
 
# File 'lib/refworks/reference.rb', line 486

def quinary_authors=(val)
  self.a5= val
end

#reference_type ⇒ Object

setup human-readable aliases as accessors I’ve been consistent with the RefWorks tagged format legend (see end of this file) plus I added some additional ones (like “authors” as a synonym for “primary_authors”) which seemed particularly useful.



262
263
264
 
# File 'lib/refworks/reference.rb', line 262

def reference_type
  rt
end

#reference_type=(val) ⇒ Object 



266
267
268
269
270
271
272
 
# File 'lib/refworks/reference.rb', line 266

def reference_type=(val)
  self.rt = val
  unless val.nil?
    self.rt_num = self.rt[:typeOrd]
    self.rt_string = self.rt[:__content__]
  end
end

#reference_type_num ⇒ Object

extension



275
276
277
 
# File 'lib/refworks/reference.rb', line 275

def reference_type_num
  rt_num
end

#reference_type_string ⇒ Object

extension



280
281
282
 
# File 'lib/refworks/reference.rb', line 280

def reference_type_string
  rt_string
end

#retrieved_date ⇒ Object 



624
625
626
 
# File 'lib/refworks/reference.rb', line 624

def retrieved_date
  rd
end

#retrieved_date=(val) ⇒ Object 



628
629
630
 
# File 'lib/refworks/reference.rb', line 628

def retrieved_date=(val)
  self.rd=val
end

#secondary_authors ⇒ Object 



426
427
428
 
# File 'lib/refworks/reference.rb', line 426

def secondary_authors
  a2
end

#secondary_authors=(val) ⇒ Object 



430
431
432
 
# File 'lib/refworks/reference.rb', line 430

def secondary_authors=(val)
  self.a2= val
end

#secondary_title ⇒ Object 



434
435
436
 
# File 'lib/refworks/reference.rb', line 434

def secondary_title
  t2
end

#secondary_title=(val) ⇒ Object 



438
439
440
 
# File 'lib/refworks/reference.rb', line 438

def secondary_title=(val)
  self.t2=val
end

#shortened_title ⇒ Object 



632
633
634
 
# File 'lib/refworks/reference.rb', line 632

def shortened_title
  st
end

#shortened_title=(val) ⇒ Object 



636
637
638
 
# File 'lib/refworks/reference.rb', line 636

def shortened_title=(val)
  self.st=val
end

#source_type ⇒ Object 



284
285
286
 
# File 'lib/refworks/reference.rb', line 284

def source_type
  sr
end

#source_type=(val) ⇒ Object 



288
289
290
 
# File 'lib/refworks/reference.rb', line 288

def source_type=(val)
  self.sr = val
end

#sponsoring_library ⇒ Object 



768
769
770
 
# File 'lib/refworks/reference.rb', line 768

def sponsoring_library
  sl
end

#sponsoring_library=(val) ⇒ Object 



772
773
774
 
# File 'lib/refworks/reference.rb', line 772

def sponsoring_library=(val)
  self.sl=val
end

#sponsoring_library_location ⇒ Object 



776
777
778
 
# File 'lib/refworks/reference.rb', line 776

def sponsoring_library_location
  ll
end

#sponsoring_library_location=(val) ⇒ Object 



780
781
782
 
# File 'lib/refworks/reference.rb', line 780

def sponsoring_library_location=(val)
  self.ll=val
end

#start_page ⇒ Object 



378
379
380
 
# File 'lib/refworks/reference.rb', line 378

def start_page
  sp
end

#start_page=(val) ⇒ Object 



382
383
384
 
# File 'lib/refworks/reference.rb', line 382

def start_page=(val)
  self.sp=val
end

#subfile_database ⇒ Object 



546
547
548
 
# File 'lib/refworks/reference.rb', line 546

def subfile_database
  sf
end

#subfile_database=(val) ⇒ Object 



550
551
552
 
# File 'lib/refworks/reference.rb', line 550

def subfile_database=(val)
  self.sf=val
end

#tertiary_authors ⇒ Object 



466
467
468
 
# File 'lib/refworks/reference.rb', line 466

def tertiary_authors
  a3
end

#tertiary_authors=(val) ⇒ Object 



470
471
472
 
# File 'lib/refworks/reference.rb', line 470

def tertiary_authors=(val)
  self.a3= val
end

#tertiary_title ⇒ Object 



490
491
492
 
# File 'lib/refworks/reference.rb', line 490

def tertiary_title
  t3
end

#tertiary_title=(val) ⇒ Object 



494
495
496
 
# File 'lib/refworks/reference.rb', line 494

def tertiary_title=(val)
  self.t3=val
end

#title ⇒ Object

alias



322
323
324
 
# File 'lib/refworks/reference.rb', line 322

def title
  t1
end

#title=(val) ⇒ Object 



326
327
328
 
# File 'lib/refworks/reference.rb', line 326

def title=(val)
  self.t1=val
end

#to_refworks_xml ⇒ Object

method to produce RefWorks XML format



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/refworks/reference.rb', line 179

def to_refworks_xml
  @xml = "<reference>"

  @xml << "<rt>#{rt_string}</rt>" if @rt
  @xml << "<sr>#{sr}</sr>" if @sr
  @xml << "<id>#{id}</id>" if @id
  a1.each {|a| @xml << "<a1>#{CGI.escapeHTML(a)}</a1>"} if @a1
  @xml << "<t1>#{CGI.escapeHTML(@t1)}</t1>" if @t1
  @xml << "<jf>#{CGI.escapeHTML(@jf)}</jf>" if @jf
  @xml << "<jo>#{CGI.escapeHTML(@jo)}</jo>" if @jo
  @xml << "<yr>#{CGI.escapeHTML(@yr)}</yr>" if @yr
  @xml << "<fd>#{CGI.escapeHTML(@fd)}</fd>" if @fd
  @xml << "<vo>#{CGI.escapeHTML(@vo)}</vo>" if @vo
  @xml << "<is>#{CGI.escapeHTML(@is)}</is>" if @is
  @xml << "<sp>#{CGI.escapeHTML(@sp)}</sp>" if @sp
  @xml << "<op>#{CGI.escapeHTML(@op)}</op>" if @op
  k1.each {|k| @xml << "<k1>#{CGI.escapeHTML(k)}</k1>"} if @k1
  @xml << "<ab>#{CGI.escapeHTML(@ab)}</ab>" if @ab
  @xml << "<no>#{CGI.escapeHTML(@no)}</no>" if @no
  a2.each {|a| @xml << "<a2>#{CGI.escapeHTML(a)}</a2>"} if @a2
  @xml << "<t2>#{CGI.escapeHTML(@t2)}</t2>" if @t2
  @xml << "<ed>#{CGI.escapeHTML(@ed)}</ed>" if @ed
  @xml << "<pb>#{CGI.escapeHTML(@pb)}</pb>" if @pb
  @xml << "<pp>#{CGI.escapeHTML(@pp)}</pp>" if @pp
  a3.each {|a| @xml << "<a3>#{CGI.escapeHTML(a)}</a3>"} if @a3
  a4.each {|a| @xml << "<a4>#{CGI.escapeHTML(a)}</a4>"} if @a4
  a5.each {|a| @xml << "<a5>#{CGI.escapeHTML(a)}</a5>"} if @a5
  @xml << "<t3>#{CGI.escapeHTML(@t3)}</t3>" if @t3
  @xml << "<sn>#{CGI.escapeHTML(@sn)}</sn>" if @sn
  @xml << "<av>#{CGI.escapeHTML(@av)}</av>" if @av
  @xml << "<ad>#{CGI.escapeHTML(@ad)}</ad>" if @ad
  @xml << "<an>#{CGI.escapeHTML(@an)}</an>" if @an
  @xml << "<la>#{CGI.escapeHTML(@la)}</la>" if @la
  @xml << "<cl>#{CGI.escapeHTML(@cl)}</cl>" if @cl
  @xml << "<sf>#{CGI.escapeHTML(@sf)}</sf>" if @sf
  @xml << "<ot>#{CGI.escapeHTML(@ot)}</ot>" if @ot
  @xml << "<lk>#{CGI.escapeHTML(@lk)}</lk>" if @lk
  @xml << "<do>#{CGI.escapeHTML(@do)}</do>" if @do
  @xml << "<cn>#{CGI.escapeHTML(@cn)}</cn>" if @cn
  @xml << "<db>#{CGI.escapeHTML(@db)}</db>" if @db
  @xml << "<ds>#{CGI.escapeHTML(@ds)}</ds>" if @ds
  @xml << "<ip>#{CGI.escapeHTML(@ip)}</ip>" if @ip
  @xml << "<rd>#{CGI.escapeHTML(@rd)}</rd>" if @rd
  @xml << "<st>#{CGI.escapeHTML(@st)}</st>" if @st
  @xml << "<u1>#{CGI.escapeHTML(@u1)}</u1>" if @u1
  @xml << "<u2>#{CGI.escapeHTML(@u2)}</u2>" if @u2
  @xml << "<u3>#{CGI.escapeHTML(@u3)}</u3>" if @u3
  @xml << "<u4>#{CGI.escapeHTML(@u4)}</u4>" if @u4
  @xml << "<u5>#{CGI.escapeHTML(@u5)}</u5>" if @u5
  @xml << "<u6>#{CGI.escapeHTML(@u6)}</u6>" if @u6
  @xml << "<u7>#{CGI.escapeHTML(@u7)}</u7>" if @u7
  @xml << "<u8>#{CGI.escapeHTML(@u8)}</u8>" if @u8
  @xml << "<u9>#{CGI.escapeHTML(@u9)}</u9>" if @u9
  @xml << "<u10>#{CGI.escapeHTML(@u10)}</u10>" if @u10
  @xml << "<u11>#{CGI.escapeHTML(@u11)}</u11>" if @u11
  @xml << "<u12>#{CGI.escapeHTML(@u12)}</u12>" if @u12
  @xml << "<u13>#{CGI.escapeHTML(@u13)}</u13>" if @u13
  @xml << "<u14>#{CGI.escapeHTML(@u14)}</u14>" if @u14
  @xml << "<u15>#{CGI.escapeHTML(@u15)}</u15>" if @u15
  @xml << "<ul>#{CGI.escapeHTML(@ul)}</ul>" if @ul
  @xml << "<sl>#{CGI.escapeHTML(@sl)}</sl>" if @sl
  @xml << "<ll>#{CGI.escapeHTML(@ll)}</ll>" if @ll
  @xml << "<cr>#{CGI.escapeHTML(@cr)}</cr>" if @cr
  @xml << "<wt>#{CGI.escapeHTML(@wt)}</wt>" if @wt
  a6.each {|a| @xml << "<a6>#{CGI.escapeHTML(a)}</a6>"} if @a6
  @xml << "<wv>#{CGI.escapeHTML(@wv)}</wv>" if @wv
  @xml << "<wp>#{CGI.escapeHTML(@wp)}</wp>" if @wp
  @xml << "<ol>#{CGI.escapeHTML(@ol)}</ol>" if @ol
  @xml << "<pmid>#{CGI.escapeHTML(@pmid)}</pmid>" if @pmid
  @xml << "<pmcid>#{CGI.escapeHTML(@pmcid)}</pmcid>" if @pmcid
  # suppressing these - they are not part of the spec and RW trips if you try to add a ref with these
  #@xml << "<fl>#{fl}</fl>" if @fl
  #@xml << "<cd>#{cd}</cd>" if @cd
  #@xml << "<md>#{md}</md>" if @md

  @xml << "</reference>"
end

#url ⇒ Object 



760
761
762
 
# File 'lib/refworks/reference.rb', line 760

def url
  ul
end

#url=(val) ⇒ Object 



764
765
766
 
# File 'lib/refworks/reference.rb', line 764

def url=(val)
  self.ul=val
end

#user_1 ⇒ Object 



640
641
642
 
# File 'lib/refworks/reference.rb', line 640

def user_1
  u1
end

#user_10 ⇒ Object 



712
713
714
 
# File 'lib/refworks/reference.rb', line 712

def user_10
  u10
end

#user_10=(val) ⇒ Object 



716
717
718
 
# File 'lib/refworks/reference.rb', line 716

def user_10=(val)
  self.u10=val
end

#user_11 ⇒ Object 



720
721
722
 
# File 'lib/refworks/reference.rb', line 720

def user_11
  u11
end

#user_11=(val) ⇒ Object 



724
725
726
 
# File 'lib/refworks/reference.rb', line 724

def user_11=(val)
  self.u11=val
end

#user_12 ⇒ Object 



728
729
730
 
# File 'lib/refworks/reference.rb', line 728

def user_12
  u12
end

#user_12=(val) ⇒ Object 



732
733
734
 
# File 'lib/refworks/reference.rb', line 732

def user_12=(val)
  self.u12=val
end

#user_13 ⇒ Object 



736
737
738
 
# File 'lib/refworks/reference.rb', line 736

def user_13
  u13
end

#user_13=(val) ⇒ Object 



740
741
742
 
# File 'lib/refworks/reference.rb', line 740

def user_13=(val)
  self.u13=val
end

#user_14 ⇒ Object 



744
745
746
 
# File 'lib/refworks/reference.rb', line 744

def user_14
  u14
end

#user_14=(val) ⇒ Object 



748
749
750
 
# File 'lib/refworks/reference.rb', line 748

def user_14=(val)
  self.u14=val
end

#user_15 ⇒ Object 



752
753
754
 
# File 'lib/refworks/reference.rb', line 752

def user_15
  u15
end

#user_15=(val) ⇒ Object 



756
757
758
 
# File 'lib/refworks/reference.rb', line 756

def user_15=(val)
  self.u15=val
end

#user_1=(val) ⇒ Object 



644
645
646
 
# File 'lib/refworks/reference.rb', line 644

def user_1=(val)
  self.u1=val
end

#user_2 ⇒ Object 



648
649
650
 
# File 'lib/refworks/reference.rb', line 648

def user_2
  u2
end

#user_2=(val) ⇒ Object 



652
653
654
 
# File 'lib/refworks/reference.rb', line 652

def user_2=(val)
  self.u2=val
end

#user_3 ⇒ Object 



656
657
658
 
# File 'lib/refworks/reference.rb', line 656

def user_3
  u3
end

#user_3=(val) ⇒ Object 



660
661
662
 
# File 'lib/refworks/reference.rb', line 660

def user_3=(val)
  self.u3=val
end

#user_4 ⇒ Object 



664
665
666
 
# File 'lib/refworks/reference.rb', line 664

def user_4
  u4
end

#user_4=(val) ⇒ Object 



668
669
670
 
# File 'lib/refworks/reference.rb', line 668

def user_4=(val)
  self.u4=val
end

#user_5 ⇒ Object 



672
673
674
 
# File 'lib/refworks/reference.rb', line 672

def user_5
  u5
end

#user_5=(val) ⇒ Object 



676
677
678
 
# File 'lib/refworks/reference.rb', line 676

def user_5=(val)
  self.u5=val
end

#user_6 ⇒ Object 



680
681
682
 
# File 'lib/refworks/reference.rb', line 680

def user_6
  u6
end

#user_6=(val) ⇒ Object 



684
685
686
 
# File 'lib/refworks/reference.rb', line 684

def user_6=(val)
  self.u6=val
end

#user_7 ⇒ Object 



688
689
690
 
# File 'lib/refworks/reference.rb', line 688

def user_7
  u7
end

#user_7=(val) ⇒ Object 



692
693
694
 
# File 'lib/refworks/reference.rb', line 692

def user_7=(val)
  self.u7=val
end

#user_8 ⇒ Object 



696
697
698
 
# File 'lib/refworks/reference.rb', line 696

def user_8
  u8
end

#user_8=(val) ⇒ Object 



700
701
702
 
# File 'lib/refworks/reference.rb', line 700

def user_8=(val)
  self.u8=val
end

#user_9 ⇒ Object 



704
705
706
 
# File 'lib/refworks/reference.rb', line 704

def user_9
  u9
end

#user_9=(val) ⇒ Object 



708
709
710
 
# File 'lib/refworks/reference.rb', line 708

def user_9=(val)
  self.u9=val
end

#volume ⇒ Object 



362
363
364
 
# File 'lib/refworks/reference.rb', line 362

def volume
  vo
end

#volume=(val) ⇒ Object 



366
367
368
 
# File 'lib/refworks/reference.rb', line 366

def volume=(val)
  self.vo=val
end

#website_editors ⇒ Object 



800
801
802
 
# File 'lib/refworks/reference.rb', line 800

def website_editors
  a6
end

#website_editors=(val) ⇒ Object 



804
805
806
 
# File 'lib/refworks/reference.rb', line 804

def website_editors=(val)
  self.a6= val
end

#website_title ⇒ Object 



792
793
794
 
# File 'lib/refworks/reference.rb', line 792

def website_title
  wt
end

#website_title=(val) ⇒ Object 



796
797
798
 
# File 'lib/refworks/reference.rb', line 796

def website_title=(val)
  self.wt=val
end

#website_version ⇒ Object 



808
809
810
 
# File 'lib/refworks/reference.rb', line 808

def website_version
  wv
end

#website_version=(val) ⇒ Object 



812
813
814
 
# File 'lib/refworks/reference.rb', line 812

def website_version=(val)
  self.wv=val
end