오픈소스 문서관리 시스템의 첫 단계인 "파일 중복 검사 어플리케이션" 제작 과정에 대한 요약 및 안내 입니다.
: "문서"에 대한 용어 정의와 문서의 속성들에 대한 정리, 문서의 하위 객체와 문서의 관계 등을 정립 등.
: "파일" 클래스의 역할, 행위와 속성들에 대한 설계
: "파일" 클래스에서 버전 클래스를 분리하게된 이유 설명
: 인스턴스를 생성하는 2가지 기법에 대한 설명과 파일 인스턴스를 생성 방식을 결정하기 위한 기술 검토.
: 문서에 포함되는 속성들에 대한 자료형, 타입 등에 대한 검토
: FileVersion 클래스 소스 및 설명
: File 클래스 소스 및 설명
: Document 클래스 소스 및 설명
: DocuemntBuilder 클래스 소스 및 설명
: 파일 중복 검사 어플리케이션 소스 및 설명
DocAr_CheckDuplication.zip
ContentAnalyzer.javapublic class DocumentBuilder {
...... 중략 .....
public Document createDocument() {
// ---- 필수 항목 점검 및 analyzer 준비 ----
if(location == null) {
throw new IllegalStateException("location property is not specified");
}
if(writer == null) {
throw new IllegalStateException("writer property is not specified");
}
ContentAnalyzer contentAnalyzer = new ContentAnalyzer(location);
contentAnalyzer.analyze();
// ---- 입력 값이 없는 항목에 대한 대체 처리 -----
if(createDate == null) {
createDate = new Date(Calendar.getInstance().getTimeInMillis());
}
if(title == null) {
title = contentAnalyzer.getFileName();
}
// -- FileVersion, File, Document 순서로 빌드 -----
FileVersion fileVersion = new FileVersion(1, createDate, description);
File file = new File(location, contentAnalyzer.getChecksum(), contentAnalyzer.getSize(), fileVersion);
Document document = new Document(title, writer, keywords,
contentAnalyzer.getAbstraction(), location, contentAnalyzer.getFormat());
document.addFile(file);
return document;
}
}
package docar.archive.document;
/**
* 문서 파일을 분석하는 클래스.
*
* @author "Sunny Kwak"
*/
public class ContentAnalyzer {
private static final String HTTP_PROTOCOL = "http";
private URL location;
private String fileName;
private long fileSize;
private String checksum;
public ContentAnalyzer(URL location) {
this.location = location;
}
public void analyze() {
InputStream inputStream = null;
try {
String protocol = location.getProtocol();
if (protocol == null
|| !protocol.toLowerCase().equals(HTTP_PROTOCOL)) {
inputStream = new FileInputStream(new java.io.File(location.toURI()));
} else {
inputStream = location.openConnection().getInputStream();
}
fileName = location.getFile();
fileSize = 0L;
checksum = getMD5Checksum(inputStream);
} catch (IOException e) {
// FIXME add logging
e.printStackTrace();
} catch (URISyntaxException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} finally {
if (inputStream != null) {
try {
inputStream.close();
} catch (IOException ignored) {
// do nothing
}
}
}
}
package docar.archive.document;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import docar.user.Writer;
/**
* '문서' 클래스.
*
* @author "Sunny Kwak"
*/
public class Document {
private String title;
private Writer writer;
private Set<String> keywords;
private String abstraction;
private URL originalLink;
private Format format;
private List<File> files;
public Document(String title, Writer writer, Set<String> keywords,
String abstraction, URL originalLink, Format format) {
if (title == null || title.isEmpty()) {
throw new IllegalArgumentException("title argument is missing");
}
if (writer == null) {
throw new IllegalArgumentException("writer argument is missing");
}
if (originalLink == null) {
throw new IllegalArgumentException(
"originalLink argument is missing");
}
if (format == null) {
throw new IllegalArgumentException("format argument is missing");
}
this.title = title;
this.writer = writer;
this.keywords = keywords;
this.abstraction = abstraction;
this.originalLink = originalLink;
this.format = format;
files = new ArrayList<File>();
}
package docar.archive.document;
import java.net.URL;
/**
* "파일"은 "문서"의 구성요소이다.
*
* - 문서는 하나 이상의 파일을 포함할 수 있다.
* - 각각의 파일은 문서의 다른 버전을 표현한다.
* - 파일은 문서의 물리적인 형태를 의미한다.
*
* @author "Sunny Kwak"
*/
public class File {
private URL location;
private String checksum;
private long size;
private FileVersion fileVersion;
/**
* '파일' 생성자.
*
* @param location 파일의 위치
* @param checksum 파일 식별을 위한 지문(finger print)
* @param size 파일 크기.
* @param fileVersion 파일 버전.
* @throws IllegalArgumentException 필수 항목이 누락된 경우, 예외 처리
*/
public File(URL location, String checksum, long size,
FileVersion fileVersion) {
if(location == null) {
throw new IllegalArgumentException("location arguement is missing");
}
if(checksum == null || checksum.isEmpty()) {
throw new IllegalArgumentException("checksum argument is missing");
}
if(size < 1) {
throw new IllegalArgumentException("Invalid fie size. Input file = " + location);
}
if(fileVersion == null) {
throw new IllegalArgumentException("fileVersion argument is missing");
}
this.location = location;
this.checksum = checksum;
this.size = size;
this.fileVersion = fileVersion;
}
public class FileVersion {
private int sequence;
private Date createDate;
private String description;
/**
* 파일 버전 생성자.
*
* @param sequence
* 버전 순번.
* @param createDate
* 버전 생성 일시
* @param description
* 버전 설명
* @throws IllegalArgumentException
* 1보다 작은 순번 혹은 날짜가 입력되지 않은 경우 예외 발생.
*/
public FileVersion(int sequence, Date createDate, String description) {
if (sequence < 1) {
throw new IllegalArgumentException("sequence must greater than 0");
}
if (createDate == null) {
throw new IllegalArgumentException("Must specify valid date");
}
this.sequence = sequence;
this.createDate = createDate;
this.description = description;
}
DocAr 에서 수집하는 문서는 웹 페이지(HTML), MS-Office 문서(파워포인트, 워드, 엑셀), 텍스트(text), PDF 등 다양하며 이러한 문서들의 원본 파일 자체와 추출한 색인 정보를 함께 저장해야 한다. 문서의 물리적인 속성을 나타내는 파일(File) 클래스에 대한 설계를 마친 후, 문서 클래스의 색인 속성에 대한 상세 설계를 진행한다. 문서의 색인 속성은 다양하며, 개별 속성에 대한 관련 기능 및 데이터 구조에 대한 설계가 필요하다.
속성 명칭 | 설명 |
제목 |
원본 파일의 명칭 혹은 문서의 첫 단락에 표시된 제목, HTML의 title tag 혹은 게시물의 제목 |
작성자 |
문서의 최초 작성자 정보. 이름, ID, e-mail, homepage (facebook 등) 정보 |
작성 일시 |
문서를 최초 생성한 일시 혹은 최종 변경 일시 |
키워드 |
문서의 핵심 혹은 요약된 정보를 나타내는 복수의 명사 |
요약 |
문서의 핵심 부분 혹은 축약된 내용 |
원본 링크 |
웹 상에서 다운로드한 문서일 경우 웹 문서에 대한 링크 |
문서 형식 |
XML, PDF, Word 등 파일 포맷(format) 에 따른 유형 |
위와 같은 색인 속성 설계를 통해 확인할 수 있는 통찰(insight)은 다음과 같다.
각 속성에 대한 구체적인 데이터 타입 설계를 진행한다.
