Class: LingotekClient::Resource::Document

Inherits:
Base
  • Object
show all
Defined in:
lib/lingotek-client/resource/document.rb

Constant Summary

Constants inherited from Base

Base::ERRORS, Base::FAIL, Base::RESULTS

Instance Attribute Summary collapse

Attributes inherited from Base

#data

Instance Method Summary collapse

Methods inherited from Base

all, find, key

Constructor Details

#initialize(attrs) ⇒ Document

Returns a new instance of Document.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/lingotek-client/resource/document.rb', line 5

def initialize(attrs)
  super(attrs)
  @id = attrs['id']
  @name = attrs['name']
  @description = attrs['description']
  @source_language = attrs['sourceLanguage']
  @tm_vault_id = attrs['tmVaultId']
  @percent_complete = attrs['percentComplete']
  @source_character_count = attrs['sourceCharacterCount']
  @source_word_count = attrs['sourceWordCount'].to_i
  @source_sentence_count = attrs['sourceSentenceCount'].to_i
  @unique_word_count = attrs['uniqueWordCount'].to_i
  @unique_sentence_count = attrs['uniqueSentenceCount'].to_i
  @duplicate_word_count = attrs['duplicateWordCount'].to_i
  @duplicate_sentence_count = attrs['duplicateSentenceCount'].to_i
  @format_tag_count = attrs['formatTagCount'].to_i
  @translation_target_refs = attrs['translationTargets']
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def description
  @description
end

#duplicate_sentence_count ⇒ Object

Returns the value of attribute duplicate_sentence_count.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def duplicate_sentence_count
  @duplicate_sentence_count
end

#duplicate_word_count ⇒ Object

Returns the value of attribute duplicate_word_count.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def duplicate_word_count
  @duplicate_word_count
end

#format_tag_count ⇒ Object

Returns the value of attribute format_tag_count.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def format_tag_count
  @format_tag_count
end

#id ⇒ Object

Returns the value of attribute id.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def name
  @name
end

#percent_complete ⇒ Object

Returns the value of attribute percent_complete.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def percent_complete
  @percent_complete
end

#source_character_count ⇒ Object

Returns the value of attribute source_character_count.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def source_character_count
  @source_character_count
end

#source_language ⇒ Object

Returns the value of attribute source_language.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def source_language
  @source_language
end

#source_sentence_count ⇒ Object

Returns the value of attribute source_sentence_count.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def source_sentence_count
  @source_sentence_count
end

#source_word_count ⇒ Object

Returns the value of attribute source_word_count.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def source_word_count
  @source_word_count
end

#tm_vault_id ⇒ Object

Returns the value of attribute tm_vault_id.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def tm_vault_id
  @tm_vault_id
end

#translation_target_refs ⇒ Object

Returns the value of attribute translation_target_refs.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def translation_target_refs
  @translation_target_refs
end

#unique_sentence_count ⇒ Object

Returns the value of attribute unique_sentence_count.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def unique_sentence_count
  @unique_sentence_count
end

#unique_word_count ⇒ Object

Returns the value of attribute unique_word_count.



4
5
6
 
# File 'lib/lingotek-client/resource/document.rb', line 4

def unique_word_count
  @unique_word_count
end

Instance Method Details

#all ⇒ Object 



24
25
26
 
# File 'lib/lingotek-client/resource/document.rb', line 24

def all
  raise Exception.new "Method not available"
end

#due_date ⇒ Object 



40
41
42
43
 
# File 'lib/lingotek-client/resource/document.rb', line 40

def due_date
  #TODO calculate the document due_date base on the lastest due date from all targets
  Time.now
end

#translation_targets ⇒ Object 



28
29
30
 
# File 'lib/lingotek-client/resource/document.rb', line 28

def translation_targets
  Lingotek::API::TranslationTarget.find_by_document_id(@id)
end

#type ⇒ Object 



32
33
34
 
# File 'lib/lingotek-client/resource/document.rb', line 32

def type
  @name.split('.').last
end