Entities

Entity List

Name	Code
Category	Category
DataItem	DataItem
DocElementUsage	DocElementUsage
Document	Document
DocumentElementAssc	DocumentElementAssc
Element	Element
Footnote	Footnote
Image	Image
Keyword	Keyword
KeywordCategoryAssc	KeywordCategoryAssc
KeywordDataItemAssc	KeywordDataItemAssc
Text	Text
TextFootnoteAssc	TextFootnoteAssc

Entity Category

Name: Category
Code: Category
Label:
Number: Generate Table: Yes

Description

The Category table is to add more information about a keyword (if desired). It is to allow keywords to be associated with different levels within a 'search tree'. For example, maybe you will want to associate a keyword with a Category.category_name = Reproduction (which would have a category_type = main division). Or maybe you will want to associate a keyword with a subdivision under Reproduction. The purpose of doing this is to allow a user to scroll through a list of keywords (arranged like the left side window of Explorer on your PC), picking the keywords on which they wish to search. See the 'SEARCH mutants' on the ZFIN homepage (http://zfin.org/ZFIN/) for an example.
->Reproduction
---> nest building
--------> nest depth
--------> nest length
--------> nest width
---> gestation
---> litter
---------> average number
---------> average weight

category_name = e.g. Reproduction, Development, Physiology, Genetics
category_type = e.g. main-division, sub-main-division, sub-division, sub-sub-division

Attribute List

Name	Code	Type	I	M
category id	category_id	I	Yes	Yes
category name	category_name	VA50	No	Yes
category type	category_type	VA50	No	Yes

Data Item category id

Data Item category name

Data Item category type

Reference List

Entity	Card	Dep.	Relationship
KeywordCategoryAssc(KeywordCategoryAssc)	1,n	Yes	Relation_448(Relation_448)

Entity DataItem

Name: DataItem
Code: DataItem
Label:
Number: Generate Table: Yes

Description

notes = anything the data master wants to record about the data item (e.g. how data was obtained (maybe it was something he heard on the TV and just wanted to place it in the db so he could follow up on it later).

title = this is what will appear as a result of a search (it will be highlighted as a 'hot link' so that the user can click it and go to the actual document or data item). If a title is not specified then the actual data item will appear. If a document does not have a title then the data item listed with sequence num equal to one will appear as the 'hotlink'.

type = e.g. document, image, text, sentence, reference, paragraph. These specify the types for which a user may search. For example, return all documents associated with keyword, or return all images associated with keyword. The developer should be able to limit the types of data for which a user can search.

Attribute List

Name	Code	Type	I	M
data item id	data_item_id	I	Yes	Yes
last modified	last_modified	DT	No	Yes
modified by	modified_by	VA40	No	Yes
notes	notes	TXT	No	No
title	title	VA255	No	No
type	type	VA40	No	Yes

Data Item data item id

Data Item notes

Data Item last modified

Data Item modified by

Data Item title

Data Item type

Reference List

Entity	Card	Dep.	Relationship
KeywordDataItemAssc(KeywordDataItemAssc)	1,n	Yes	Relation_104(relation_104)

Entity DocElementUsage

Name: DocElementUsage
Code: DocElementUsage
Label:
Number: Generate Table: Yes

Description

This is to describe how an Image or Text is used in a doument. For example, is the image used as a table, a figure or something else. This is not a label to be seen on the document but rather data to describe the semantics of the element.

For example, the Text data item 'Burrow (Nest) Construction' may appear as the 'document header' in one document, but as a 'subsection header' in another document.

The XML tags to surround an element will be taken from the usage name.

Attribute List

Name	Code	Type	I	M
description	description	TXT	No	No
usage code	usage_code	A5	Yes	Yes
usage name	usage_name	VA50	No	No

Data Item usage code

Data Item usage name

Data Item description

Reference List

Entity	Card	Dep.	Relationship
DocumentElementAssc(DocumentElementAssc)	0,n	No	elemasscelemtype(elemasscelemtype)

Entity Document

Name: Document
Code: Document
Label:
Number: Generate Table: Yes

Reference List

Entity	Card	Dep.	Relationship
DocumentElementAssc(DocumentElementAssc)	1,n	Yes	Relation_123(relation_123)

Entity DocumentElementAssc

Name: DocumentElementAssc
Code: DocumentElementAssc
Label:
Number: Generate Table: Yes

Description

sequence num specifies the order in which the elements will be arranged on the document.

label = a header that may appear on the document above the element.

caption = text that will appear directly below an element (images mostly). Text such as you see below images in a journal (giving Fig. #, title of image, name of photographer, etc.).

footnote num = the number associated with a footnote for a Text within a particular Document. A Text data item can have a footnote. The Text can appear in any number of documents. The footnote will follow the Text from Document to Document. However, the Text may have a different sequence number in different documents. Any number of Text data items within a document can have a footnote. The footnote num will appear to the right of the relevant Text and to the left of the actual footnote. Therefore, the footnote num will allow for easy matching between the Text and its' footnote.

Attribute List

Name	Code	Type	I	M
caption	caption	TXT	No	No
footnote num	footnote_num	I	No	No
label	label	VA255	No	No
sequence num	sequence_num	I	No	Yes

Data Item sequence num

Data Item label

Data Item caption

Data Item footnote num

Reference List

Entity	Card	Dep.	Relationship
DocElementUsage(DocElementUsage)	0,1	No	elemasscelemtype(elemasscelemtype)
Document(Document)	1,1	Yes	Relation_123(relation_123)
Element(Element)	1,1	Yes	Relation_124(relation_124)

Entity Element

Name: Element
Code: Element
Label:
Number: Generate Table: Yes

Description

type = image or text. This info may be helpful in telling browser how to handle the data.

Reference List

Entity	Card	Dep.	Relationship
DocumentElementAssc(DocumentElementAssc)	0,n	Yes	Relation_124(relation_124)

Entity Footnote

Name: Footnote
Code: Footnote
Label:
Number: Generate Table: Yes

Attribute List

Name	Code	Type	I	M
footnote	footnote	TXT	No	Yes
footnote id	footnote_id	I	Yes	Yes

Data Item footnote id

Data Item footnote

Reference List

Entity	Card	Dep.	Relationship
TextFootnoteAssc(TextFootnoteAssc)	1,n	Yes	Relation_96(relation_96)

Entity Image

Name: Image
Code: Image
Label:
Number: Generate Table: Yes

Attribute List

Name	Code	Type	I	M
image	image	PIC	No	Yes
thumbnail image	thumbnail_image	PIC	No	No

Data Item image

Data Item thumbnail image

Entity Keyword

Name: Keyword
Code: Keyword
Label:
Number: Generate Table: Yes

Description

Examples of keywords: burrow, litter size, gestation period, average neonate weight

I thought having a keyword_id as the identifier would make it easier to reference the keywords later.

Attribute List

Name	Code	Type	I	M
keyword	keyword	VA50	No	Yes
keyword id	keyword_id	I	Yes	Yes

Data Item keyword id

Data Item keyword

Reference List

Entity	Card	Dep.	Relationship
KeywordCategoryAssc(KeywordCategoryAssc)	0,n	Yes	Relation_447(Relation_447)
KeywordDataItemAssc(KeywordDataItemAssc)	0,n	Yes	Relation_103(relation_103)

Entity KeywordCategoryAssc

Name: KeywordCategoryAssc
Code: KeywordCategoryAssc
Label:
Number: Generate Table: Yes

Reference List

Entity	Card	Dep.	Relationship
Category(Category)	1,1	Yes	Relation_448(Relation_448)
Keyword(Keyword)	1,1	Yes	Relation_447(Relation_447)

Entity KeywordDataItemAssc

Name: KeywordDataItemAssc
Code: KeywordDataItemAssc
Label:
Number: Generate Table: Yes

Reference List

Entity	Card	Dep.	Relationship
DataItem(DataItem)	1,1	Yes	Relation_104(relation_104)
Keyword(Keyword)	1,1	Yes	Relation_103(relation_103)

Entity Text

Name: Text
Code: Text
Label:
Number: Generate Table: Yes

Attribute List

Name	Code	Type	I	M
text	text	TXT	No	Yes

Data Item text

Reference List

Entity	Card	Dep.	Relationship
TextFootnoteAssc(TextFootnoteAssc)	0,n	Yes	Relation_95(relation_95)

Entity TextFootnoteAssc

Name: TextFootnoteAssc
Code: TextFootnoteAssc
Label:
Number: Generate Table: Yes

Reference List

Entity	Card	Dep.	Relationship
Footnote(Footnote)	1,1	Yes	Relation_96(relation_96)
Text(Text)	1,1	Yes	Relation_95(relation_95)

Home Page - Previous page - Next page