grammarscope.browser.ControlDocumentView Class Reference

Inheritance diagram for grammarscope.browser.ControlDocumentView:

Collaboration diagram for grammarscope.browser.ControlDocumentView:

Public Member Functions
	ControlDocumentView ()
void	notified (final Event event)
abstract List< Document >	getDocuments ()
Document	makeDocument (final URL url)
Document	makeTextDocument (final String text)
void	startDocumentLoading (final URL uRL)
void	startDocument (final String text)
void	startXmlDocumentLoading (final URL uRL)
void	startProcessing (final Document document, final boolean recognize, final boolean parse, final boolean analyze, final boolean clear, final boolean waitServerReady)
void	commandOpen ()
void	commandOpenUrl ()
void	commandOpenPaste ()
void	commandInput ()
void	commandOpenXml (final boolean dynamicRequest, final boolean passURL, final boolean passFile, final boolean useServletUrl)
String	getUrl (final Setting setting, final boolean setProperty)
Public Member Functions inherited from grammarscope.browser.Modeling
	Modeling ()
void	commandLoadRelationFilter ()
void	commandSaveRelationFilter ()
void	commandLoadRelationPalette ()
void	commandSaveRelationPalette ()
Public Member Functions inherited from grammarscope.browser.Messenging
	Messenging ()
EventFirer	getFirer ()
Public Member Functions inherited from grammarscope.browser.Client
	Client ()
void	onServerBound (final boolean success)
Public Member Functions inherited from grammarscope.queue.ServerLock
boolean	getState ()
void	lock (final Observable observable)

Static Public Member Functions
static Document	makeXmlDocument (final URL url)

Protected Member Functions
void	initControlDocumentView ()
void	startTask ()
void	endTask ()
void	onDone (final Document document, final boolean parsed, final boolean analyzed)
void	onPublish (final Document document, final List< Integer > sentenceIndices, final boolean parsed, final boolean analyzed)
Protected Member Functions inherited from grammarscope.browser.Modeling
void	initRelationModel ()
void	initRelationModel (final RelationModel relationModel)
void	makeRelationModel ()
void	setRelationModel (final RelationModel relationModel)
Protected Member Functions inherited from grammarscope.browser.Client
void	initClient (final Properties clientProperties, final String[] args)
void	clearClient ()
void	updateClient (final Properties clientProperties)
void	bindToServer ()
void	setup (final Properties properties)
void	checkCoreNlp ()
Protected Member Functions inherited from grammarscope.queue.ServerLock
void	resetLock ()

Protected Attributes
TypedDependencyProvider	typedDependencyProvider
TypedDependencyMode	typedDependencyMode
Protected Attributes inherited from grammarscope.browser.Modeling
RelationModel	relationModel
RelationOrderedFilter	relationFilter
RelationFilter	relationFilter2
RelationPalette	relationPalette
Protected Attributes inherited from grammarscope.browser.Client
IServer	server
IBuilder	builder
boolean	useNullServer
boolean	loadServer
Properties	clientProperties

Static Protected Attributes
static boolean	xmlCompatibilityMode

Package Functions
abstract Settings	getSettings ()
abstract String[]	getArgs ()
abstract Observable	getObservable ()
abstract void	addView (final View view)
Package Functions inherited from grammarscope.browser.Modeling
abstract JFrame	getFrame ()

Private Member Functions
View	makeView ()
void	makeView (final Document document, @SuppressWarnings("unused") final String documentPath)
String	getXmlFileUrl ()
String	getTextFileUrl ()

Static Private Member Functions
static Settings	makeSettings (final Settings settings, final String[] args)
static String	makeUrl (final String url0, final String target, final boolean targetIsUrl)
static String	encode (final String str)

Static Private Attributes
static final String	USE_URL_VARIABLE = "\\$\\{USEURL\\}"
static final String	URL_VARIABLE = "\\$\\{URL\\}"
static final String	TEXT_VARIABLE = "\\$\\{TEXT\\}"

Detailed Description

ControlDocumentView

Author

Bernard Bou

Constructor & Destructor Documentation

ControlDocumentView()

grammarscope.browser.ControlDocumentView.ControlDocumentView

(

)

Constructor

Member Function Documentation

addView()

abstract void grammarscope.browser.ControlDocumentView.addView ( final View  view )

abstractpackage

Add view

Parameters

view

view

Reimplemented in grammarscope.browser.Browser.

commandInput()

void grammarscope.browser.ControlDocumentView.commandInput

(

)

Input document handler

commandOpen()

void grammarscope.browser.ControlDocumentView.commandOpen

(

)

Open command handler

commandOpenPaste()

void grammarscope.browser.ControlDocumentView.commandOpenPaste

(

)

Paste document handler

commandOpenUrl()

void grammarscope.browser.ControlDocumentView.commandOpenUrl

(

)

Open URL command handler

commandOpenXml()

void grammarscope.browser.ControlDocumentView.commandOpenXml	(	final boolean	dynamicRequest,
		final boolean	passURL,
		final boolean	passFile,
		final boolean	useServletUrl
	)

Open XML document command handler

Parameters

dynamicRequest	true if dynamic request
passURL	whether to pass url
passFile	whether to pass file
useServletUrl	whether to use servlet url

encode()

static String grammarscope.browser.ControlDocumentView.encode ( final String  str )

staticprivate

Encode encoded

Parameters

str

string

Returns

encoded string

endTask()

void grammarscope.browser.ControlDocumentView.endTask ( )

protected

Release input block

Reimplemented in grammarscope.browser.Browser.

getArgs()

abstract String [] grammarscope.browser.ControlDocumentView.getArgs ( )

abstractpackage

Get command-line arguments

Returns

arguments

Reimplemented in grammarscope.browser.Browser.

getDocuments()

abstract List<Document> grammarscope.browser.ControlDocumentView.getDocuments ( )

abstract

Get documents

Returns

documents

Reimplemented in grammarscope.browser.Browser.

getObservable()

abstract Observable grammarscope.browser.ControlDocumentView.getObservable ( )

abstractpackage

Get observable

Returns

observable

Reimplemented in grammarscope.browser.Browser.

getSettings()

abstract Settings grammarscope.browser.ControlDocumentView.getSettings ( )

abstractpackage

Reimplemented from grammarscope.browser.Modeling.

Reimplemented in grammarscope.browser.Browser.

getTextFileUrl()

String grammarscope.browser.ControlDocumentView.getTextFileUrl ( )

private

Get text file url

Returns

Url string

getUrl()

String grammarscope.browser.ControlDocumentView.getUrl	(	final Setting	setting,
		final boolean	setProperty
	)

Get Url

Parameters

setting	setting
setProperty	whether to se property

Returns

Url string

getXmlFileUrl()

String grammarscope.browser.ControlDocumentView.getXmlFileUrl ( )

private

Get xml file url

Returns

Url string

initControlDocumentView()

void grammarscope.browser.ControlDocumentView.initControlDocumentView ( )

protected

Initialize

makeDocument()

Document grammarscope.browser.ControlDocumentView.makeDocument

(

final URL

url

)

Load the document

Parameters

url	url to the document

Returns

document

makeSettings()

static Settings grammarscope.browser.ControlDocumentView.makeSettings ( final Settings  settings, final String[]  args  )

staticprivate

Make settings allowing for overrides on command line

Parameters

settings	settings
args	command-line arguments

Returns

settings (properties)

makeTextDocument()

Document grammarscope.browser.ControlDocumentView.makeTextDocument

(

final String

text

)

Load the document

Parameters

text

text

Returns

document

makeUrl()

static String grammarscope.browser.ControlDocumentView.makeUrl ( final String  url0, final String  target, final boolean  targetIsUrl  )

staticprivate

Make Url

Parameters

url0	url
target	target
targetIsUrl	whether url (true) or text (false) has been passed as target

Returns

url

makeView() [1/2]

View grammarscope.browser.ControlDocumentView.makeView ( )

private

Make view

Returns

view

makeView() [2/2]

void grammarscope.browser.ControlDocumentView.makeView ( final Document  document, @SuppressWarnings("unused") final String  documentPath  )

private

Make view

Parameters

document	document
documentPath	document path

makeXmlDocument()

static Document grammarscope.browser.ControlDocumentView.makeXmlDocument ( final URL  url )

static

Load the document

Parameters

url	url to the document

Returns

document

notified()

void grammarscope.browser.ControlDocumentView.notified

(

final Event

event

)

Event notification

Parameters

event

event

Reimplemented from grammarscope.browser.Modeling.

Reimplemented in grammarscope.browser.Browser.

onDone()

void grammarscope.browser.ControlDocumentView.onDone ( final Document  document, final boolean  parsed, final boolean  analyzed  )

protected

Document parsed/analyzed callback

Parameters

document	document
parsed	parsed
analyzed	analyzed

Reimplemented in grammarscope.browser.Browser.

onPublish()

void grammarscope.browser.ControlDocumentView.onPublish ( final Document  document, final List< Integer >  sentenceIndices, final boolean  parsed, final boolean  analyzed  )

protected

Document part published callback

Parameters

document	document
sentenceIndices	indices of done sentences (-1=all done)
parsed	parsed
analyzed	analyzed

Reimplemented in grammarscope.browser.Browser.

startDocument()

void grammarscope.browser.ControlDocumentView.startDocument

(

final String

text

)

Start document input thread

Parameters

text

text

startDocumentLoading()

void grammarscope.browser.ControlDocumentView.startDocumentLoading

(

final URL

uRL

)

Start document loading thread

Parameters

uRL	url to the document

startProcessing()

void grammarscope.browser.ControlDocumentView.startProcessing	(	final Document	document,
		final boolean	recognize,
		final boolean	parse,
		final boolean	analyze,
		final boolean	clear,
		final boolean	waitServerReady
	)

Start processing thread

Parameters

document	document
recognize	recognize (pos, named entities)
parse	parse
analyze	analyze
clear	clear cached data
waitServerReady	wait until server is ready

Reimplemented in grammarscope.browser.Browser.

startTask()

void grammarscope.browser.ControlDocumentView.startTask ( )

protected

Block input when task is initiated.

Reimplemented in grammarscope.browser.Browser.

startXmlDocumentLoading()

void grammarscope.browser.ControlDocumentView.startXmlDocumentLoading

(

final URL

uRL

)

Start XML document loading thread

Parameters

uRL	url to the document

Member Data Documentation

TEXT_VARIABLE

final String grammarscope.browser.ControlDocumentView.TEXT_VARIABLE = "\\$\\{TEXT\\}"

staticprivate

typedDependencyMode

TypedDependencyMode grammarscope.browser.ControlDocumentView.typedDependencyMode

protected

Typed Dependency mode

typedDependencyProvider

TypedDependencyProvider grammarscope.browser.ControlDocumentView.typedDependencyProvider

protected

Typed Dependency provider

URL_VARIABLE

final String grammarscope.browser.ControlDocumentView.URL_VARIABLE = "\\$\\{URL\\}"

staticprivate

USE_URL_VARIABLE

final String grammarscope.browser.ControlDocumentView.USE_URL_VARIABLE = "\\$\\{USEURL\\}"

staticprivate

xmlCompatibilityMode

boolean grammarscope.browser.ControlDocumentView.xmlCompatibilityMode

staticprotected

XML compatibility mode

---

The documentation for this class was generated from the following file:

• grammarscope/browser/src/main/java/grammarscope/browser/ControlDocumentView.java