-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing16.html
executable file
·879 lines (803 loc) · 32.2 KB
/
listing16.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>JavaEOGenerator - /src/main/java/com/webobjects/generator/Generator.java</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/Java/index.html">Java</a> > <a href="../../samplecode/Java/idxWebObjects-date.html">WebObjects</a> > <A HREF="javascript:location.replace('index.html');">JavaEOGenerator</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">JavaEOGenerator</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/src/main/java/com/webobjects/generator/Generator.java</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/src/main/java/com/webobjects/entitygenerator/EntityBaseComponent.java</option>
<option value="listing2.html">/src/main/java/com/webobjects/entitygenerator/EntityComponent.java</option>
<option value="listing3.html">/src/main/java/com/webobjects/entitygenerator/EntityConfiguration.java</option>
<option value="listing4.html">/src/main/java/com/webobjects/entitygenerator/EntityContext.java</option>
<option value="listing5.html">/src/main/java/com/webobjects/entitygenerator/EntityGenerator.java</option>
<option value="listing6.html">/src/main/java/com/webobjects/entitygenerator/EOAttributeProxy.java</option>
<option value="listing7.html">/src/main/java/com/webobjects/entitygenerator/EOEntityProxy.java</option>
<option value="listing8.html">/src/main/java/com/webobjects/entitygenerator/EOEntityRelatedProxy.java</option>
<option value="listing9.html">/src/main/java/com/webobjects/entitygenerator/EOFetchSpecificationProxy.java</option>
<option value="listing10.html">/src/main/java/com/webobjects/entitygenerator/EOPropertyProxy.java</option>
<option value="listing11.html">/src/main/java/com/webobjects/entitygenerator/EORelationshipProxy.java</option>
<option value="listing12.html">/src/main/java/com/webobjects/eogenerator/EOGenerator.java</option>
<option value="listing13.html">/src/main/java/com/webobjects/eogenerator/EOGeneratorApplication.java</option>
<option value="listing14.html">/src/main/java/com/webobjects/eogenerator/EOGeneratorSession.java</option>
<option value="listing15.html">/src/main/java/com/webobjects/generator/Configuration.java</option>
<option value="listing16.html">/src/main/java/com/webobjects/generator/Generator.java</option>
<option value="listing17.html">/src/main/java/com/webobjects/generator/GeneratorComponent.java</option>
<option value="listing18.html">/src/main/java/com/webobjects/generator/GeneratorContext.java</option>
<option value="listing19.html">/src/main/java/com/webobjects/generator/GeneratorProxy.java</option>
<option value="listing20.html">/src/main/java/com/webobjects/generator/StringUtils.java</option>
<option value="listing21.html">/wo-resources/Resources/Main.wo/Main.html</option></select>
</p>
</form>
<p><strong><a href="JavaEOGenerator.zip">Download Sample</a></strong> (“JavaEOGenerator.zip”, 17.14M)<BR>
<strong><a href="JavaEOGenerator.dmg">Download Sample</a></strong> (“JavaEOGenerator.dmg”, 17.41M)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
* Copyright 2005 - 2007 Apple, Inc. All rights reserved.
*
* IMPORTANT: This Apple software is supplied to you by Apple, Inc. ("Apple") in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this Apple software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this Apple software.
*
* In consideration of your agreement to abide by the following terms, and subject to these terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in this original Apple software (the "Apple Software"), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software. Neither the name, trademarks, service marks or logos of Apple Computer, Inc. may be used to endorse or promote products derived from the Apple Software without specific prior written permission from Apple. Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by Apple herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the Apple Software may be incorporated.
*
* The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
package com.webobjects.generator;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import com.webobjects.foundation._NSDelegate;
/**
* @since 5.4
*/
public class Generator {
/**
* Configuration object
*/
protected Configuration _configuration;
/**
* Generation context
*/
protected GeneratorContext _context;
/**
* Java file extension
*/
public static final String JavaFileExtension = ".java";
/**
* This interface defines a delegate to the Generator class to allow easy subclassing of the Generator.
*/
public static interface ClassDelegate {
/**
* Allows the delegate the opportunity to construct and return a different Generator object.
*
* @return Should return a Generator Factory Object.
* @see #classDelegate()
* @see #setClassDelegate(Object anObject)
*/
public Generator newGenerator();
}
/**
*
*/
protected Generator() {
super();
// WOMLTemplateExtensions.instance().setDynamicAttributePrefix("$");
// WOMLTemplateExtensions.instance().setDynamicAttributeSuffix("");
}
private static final _NSDelegate _generatorClassDelegate = new _NSDelegate(ClassDelegate.class);
/**
* Assigns <code>delegate</code> as Generator's class delegate. The class delegate is optional; it allows modification of the creation of theGenerator for a model.
*
* @param delegate
* The object to set as Generator's class delegate.
* @see #classDelegate()
* @see Generator.ClassDelegate
*/
public static void setClassDelegate(Object delegate) {
_generatorClassDelegate.setDelegate(delegate);
}
/**
* Returns Generator's class delegate.
*
* @return Generator's class delegate.
* @see #setClassDelegate(Object anObject)
* @see Generator.ClassDelegate
*/
public static Object classDelegate() {
return _generatorClassDelegate.delegate();
}
/**
* Returns a new instance of Generator using the class delegate if it exists.
*
* @return new instance of Generator
*/
public static Generator newGenerator() {
Generator generator = null;
// give our delegate (IB or EOModeler, perhaps) a chance to pick the generator
if (_generatorClassDelegate != null && _generatorClassDelegate.respondsTo("newGenerator")) {
generator = (Generator) _generatorClassDelegate.perform("newGenerator");
}
return (generator != null ? generator : new Generator());
}
/**
* Factory method to create a new Configuration object.
*
* @param argv
* array of string passed to the application.
* @return newly initialized Configuration Object
*/
protected Configuration createConfiguration(String argv[]) {
return new Configuration(argv);
}
/**
* Return the generator context
*
* @return generator context
*/
public GeneratorContext context() {
if (_context == null) {
_context = this.createContext();
}
return _context;
}
/**
* Factory method to create a new context
*
* @return new context
*/
protected GeneratorContext createContext() {
return new GeneratorContext(_configuration);
}
/**
* Configure the generator with a set of arguments.
*
* @param argv
*/
public void configure(String argv[]) {
_configuration = this.createConfiguration(argv);
}
/**
* Logs a statement to the console if in verbose mode
*
* @param log
*/
protected void logStatement(String log) {
this.logStatement(log, this.verbose());
}
/**
* Logs a statement to the console
*
* @param log
* @param verbose
*/
protected void logStatement(String log, boolean verbose) {
if (verbose) {
this.println(log);
}
}
/**
* Prints a statement. The base implementation does nothing and needs to be overwritten to display anything.
*
* @param log
*/
protected void println(String log) {
// Place holder should be verwritten by subclasses
}
/**
* Excecute the generation based on the arguments.
*/
public void run() {
if (this.help()) {
this.showHelp();
}
if (this.version()) {
this.showVersion();
}
this.logStatement(this.toString());
this.logStatement("Start generation");
this.generate();
this.logStatement("End generation");
}
/**
* Generate the java file for the requested options. The defualt implementation does nothing.
*/
public void generate() {
// Stub
}
/**
* Generates the required files for the target
*
* @param targetObject
*/
public void generateForTargetObject(Object targetObject) {
// First the super class
URL classUrl = this.urlForClass(targetObject);
this.logStatement("URL for super class: '" + classUrl + "'");
if (classUrl != null) {
File generatedClassFile = null;
try {
generatedClassFile = new File(classUrl.toURI());
} catch (URISyntaxException exception) {
this.logStatement("Undefined super class file: '" + classUrl + "'", true);
}
if (this.shouldGenerateClassFile(generatedClassFile)) {
this.logStatement("Generating super class file: '" + generatedClassFile + "'");
String generatedFile = this.generateClassFileForTargetObject(targetObject);
if (generatedFile.length() > 0) {
if (!this.isIdenticalToExistingFile(generatedFile, generatedClassFile)) {
this.logStatement("Overwritting super class file: '" + generatedClassFile + "'");
this.ensurePathExistance(generatedClassFile);
try {
BufferedWriter out = new BufferedWriter(new FileWriter(generatedClassFile));
out.write(generatedFile);
out.flush();
out.close();
} catch (IOException exception) {
this.logStatement("Cannot write super class file: '" + generatedClassFile + "'", true);
}
} else {
this.logStatement("Skipping super class file: '" + generatedClassFile + "'");
}
}
}
} else {
this.logStatement("Super class url is null: '" + targetObject + "'", true);
}
// Then the sub class
URL subClassUrl = this.urlForSubClass(targetObject);
this.logStatement("URL for sub class: '" + subClassUrl + "'");
if (subClassUrl != null) {
File generatedSubClassFile = null;
try {
generatedSubClassFile = new File(subClassUrl.toURI());
} catch (URISyntaxException exception) {
this.logStatement("Undefined sub class file: '" + subClassUrl + "'", true);
}
if (this.shouldGenerateSubClassFile(generatedSubClassFile)) {
this.logStatement("Generating sub class file: '" + generatedSubClassFile + "'");
this.ensurePathExistance(generatedSubClassFile);
String generatedFile = this.generateSubClassFileForTargetObject(targetObject);
if (generatedFile.length() > 0) {
try {
BufferedWriter out = new BufferedWriter(new FileWriter(generatedSubClassFile));
out.write(generatedFile);
out.flush();
out.close();
} catch (IOException exception) {
this.logStatement("Cannot write sub class file: '" + generatedSubClassFile + "'", true);
}
}
}
} else {
this.logStatement("Sub class url is null: '" + targetObject + "'", true);
}
}
/**
* Checks the that file path exists. If it does not creates it.
*
* @param aFile
*/
protected void ensurePathExistance(File aFile) {
if ((aFile != null) && !aFile.exists()) {
File path = aFile.getParentFile();
if (path != null) {
path.mkdirs();
}
}
}
/**
* Checks if it needs to generate the class file
*
* @param aFile
* @return true if the class file need to be generated
*/
protected boolean shouldGenerateClassFile(File aFile) {
return true;
}
/**
* Checks if it needs to generate the sub class file
*
* @param aFile
* @return true if the sub class file need to be generated
*/
protected boolean shouldGenerateSubClassFile(File aFile) {
return (aFile != null) && !aFile.exists();
}
/**
* Checks if the generated file is identical to the existing file on disk. This checks the actual content of teh files.
*
* @param generatedFile
* @param aFile
* @return true if the files are identical.
*/
protected boolean isIdenticalToExistingFile(String generatedFile, File aFile) {
if ((aFile == null) || (!aFile.exists())) {
return false;
} else {
StringBuilder existingContent = new StringBuilder();
try {
BufferedReader in = new BufferedReader(new FileReader(aFile));
try {
while (in.ready()) {
existingContent.append(in.readLine() + "\n");
}
} catch (IOException exception) {
this.logStatement("Error reading existing file : '" + aFile + "', " + exception.toString(), true);
}
} catch (FileNotFoundException exception) { /* This has already been taken care of */}
return existingContent.toString().trim().equals(generatedFile.trim());
}
}
/**
* Generate the class for the target object
*
* @param targetObject
* @return generated class file
*/
public String generateClassFileForTargetObject(Object targetObject) {
String generatedFile = this.generateFileForTargetObject(targetObject, this.templateForClass(targetObject), GeneratorComponent.GenerateSuperclass);
this.logStatement("Generated file for class: \n'" + generatedFile + "'");
return generatedFile;
}
/**
* Generate the sub class for the target object
*
* @param targetObject
* @return generated class file
*/
public String generateSubClassFileForTargetObject(Object targetObject) {
String generatedFile = this.generateFileForTargetObject(targetObject, this.templateForSubClass(targetObject), GeneratorComponent.GenerateSubclass);
this.logStatement("Generated file for sub class: \n'" + generatedFile + "'");
return generatedFile;
}
private <T> String generateFileForTargetObject(T targetObject, String fileTemplate, Boolean superclass) {
GeneratorComponent<T> template = this.componentForTargetObject(targetObject);
template.setTargetObject(targetObject);
template.setSuperclassGeneration(superclass);
template.setTemplateString(fileTemplate);
template.setSuperClassPrefix(_configuration != null ? _configuration.prefix() : "_");
return template.generateResponse().contentString().replace("&lt;", "<").replace("&gt;", ">").replace("&amp;", "&").replace("&quot;", "\"").replace("&apos;", "'").trim();
}
/**
* Returns the template for the class
*
* @param targetObject
* @return template
*/
protected String templateForClass(Object targetObject) {
URL templateFileUrl = (_configuration != null ? _configuration.javaTemplate() : null);
return (templateFileUrl != null ? this.templateForObject(targetObject, templateFileUrl) : "");
}
/**
* Returns the template for the sub class
*
* @param targetObject
* @return template
*/
protected String templateForSubClass(Object targetObject) {
URL templateFileUrl = (_configuration != null ? _configuration.subClassJavaTemplate() : null);
return (templateFileUrl != null ? this.templateForObject(targetObject, templateFileUrl) : "");
}
private String templateForObject(Object targetObject, URL templateFileUrl) {
StringBuilder template = new StringBuilder();
File templateFile = null;
try {
templateFile = new File(templateFileUrl.toURI());
} catch (URISyntaxException exception) {
this.logStatement("Undefined template: '" + templateFileUrl + "'", true);
}
if (templateFile != null) {
try {
BufferedReader in = new BufferedReader(new FileReader(templateFile));
try {
while (in.ready()) {
template.append(in.readLine() + "\n");
}
} catch (IOException exception) {
this.logStatement("Error reading template: '" + templateFileUrl + "', " + exception.toString(), true);
}
} catch (FileNotFoundException exception) {
this.logStatement("Non existant template: '" + templateFileUrl + "'", true);
}
}
return template.toString().trim();
}
/**
* Factory method for the generator component class
*
* @param <T>
* Type of the object for the generation
* @param targetObject
* target object for generation
* @return generator component
*/
protected <T> GeneratorComponent<T> componentForTargetObject(T targetObject) {
return new GeneratorComponent<T>(this.context());
}
/**
* Generate the filename from the filename template
*
* @param targetObject
* @param fileExtension
* @return filename
*/
protected String fileNameForClass(Object targetObject, String fileExtension) {
return this.generateFilenameForClass(targetObject, this.defaultFileNameForObject(targetObject), fileExtension);
}
/**
* Generate the filename from the filename template for the sub class
*
* @param targetObject
* @param fileExtension
* @return filename
*/
protected String fileNameForSubClass(Object targetObject, String fileExtension) {
return this.generateFilenameForSubClass(targetObject, this.defaultFileNameForObject(targetObject), fileExtension);
}
/**
* Returns teh defualt filename for the class
*
* @param targetObject
* @return filename
*/
protected String defaultFileNameForObject(Object targetObject) {
return "";
}
/**
* @param targetObject
* @return filename
*/
protected String defaultFileExtensionForObject(Object targetObject) {
return JavaFileExtension;
}
/**
* @param <T>
* Type of the object for the generation
* @param targetObject
* target object for generation
* @param defaultName
* @param fileExtension
* @return filename
*/
protected <T> String generateFilenameForClass(T targetObject, String defaultName, String fileExtension) {
return this.generateFilenameForObject(targetObject, defaultName, fileExtension, GeneratorComponent.GenerateSuperclass);
}
/**
* @param <T>
* Type of the object for the generation
* @param targetObject
* target object for generation
* @param defaultName
* @param fileExtension
* @return filename
*/
protected <T> String generateFilenameForSubClass(T targetObject, String defaultName, String fileExtension) {
return this.generateFilenameForObject(targetObject, defaultName, fileExtension, GeneratorComponent.GenerateSubclass);
}
private <T> String generateFilenameForObject(T targetObject, String defaultName, String fileExtension, Boolean superclass) {
String filename = "";
String filenameTemplate = (_configuration != null ? _configuration.filenameTemplate() : "");
if (filenameTemplate.length() > 0) {
GeneratorComponent<T> template = this.componentForTargetObject(targetObject);
template.setTargetObject(targetObject);
template.setSuperclassGeneration(superclass);
template.setTemplateString(filenameTemplate);
template.setSuperClassPrefix(_configuration != null ? _configuration.prefix() : "_");
filename = template.generateResponse().contentString().trim();
} else {
if (GeneratorComponent.GenerateSuperclass.equals(superclass)) {
String className = this.classNameWithoutPackage(defaultName, fileExtension);
String packageName = this.packageName(defaultName, fileExtension);
String prefix = (_configuration != null ? _configuration.prefix() : "_");
filename = (packageName.length() > 0 ? packageName + "." : "") + prefix + className;
} else {
filename = defaultName;
}
}
filename = (filename.endsWith(fileExtension) ? filename : filename + fileExtension);
return filename;
}
/**
* Returns the class name
*
* @param name
* fully qualified class name
* @param fileExtension
* @return class name
*/
protected String classNameWithoutPackage(String name, String fileExtension) {
String nameWithout = name;
if (name.endsWith(fileExtension)) {
nameWithout = name.substring(0, name.lastIndexOf(fileExtension));
}
int separator = nameWithout.lastIndexOf('.');
return (separator > 0 ? nameWithout.substring(separator + 1) : nameWithout) + fileExtension;
}
/**
* Return the package name of the class name passed as parameter
*
* @param name
* fully qualified class name
* @param fileExtension
* @return package name
*/
public String packageName(String name, String fileExtension) {
String nameWithout = name;
if (name.endsWith(fileExtension)) {
nameWithout = name.substring(0, name.lastIndexOf(fileExtension));
}
int separator = nameWithout.lastIndexOf('.');
return (separator > 0 ? nameWithout.substring(0, separator) : "");
}
/**
* Return the URL for the class file
*
* @param targetObject
* @return URL of the class file
*/
protected URL urlForClass(Object targetObject) {
return this.buildURL(this.destination(), this.fileNameForClass(targetObject, this.defaultFileExtensionForObject(targetObject)), this.defaultFileExtensionForObject(targetObject));
}
/**
* Return the URL for the sub class file
*
* @param targetObject
* @return URL of the sub class file
*/
protected URL urlForSubClass(Object targetObject) {
return this.buildURL(this.subClassDestination(), this.fileNameForSubClass(targetObject, this.defaultFileExtensionForObject(targetObject)), this.defaultFileExtensionForObject(targetObject));
}
private URL buildURL(URL destination, String filename, String fileExtension) {
URL result = null;
File targetDirectory = null;
try {
targetDirectory = new File(destination.toURI());
} catch (URISyntaxException exception) {
this.logStatement("Undefined path for directory: '" + destination + "'", true);
}
String filenameWithoutPackage = this.classNameWithoutPackage(filename, fileExtension);
String packageName = this.packageName(filename, fileExtension).replace('.', '/');
boolean packageDirectories = (_configuration != null ? _configuration.packageDirectories().booleanValue() : true);
String qualifiedPath = (packageDirectories && (packageName.length() > 0) ? packageName + "/" : "") + filenameWithoutPackage;
if (qualifiedPath.length() > 0) {
File targetClass = new File(targetDirectory, qualifiedPath);
try {
result = targetClass.toURL();
} catch (MalformedURLException exception) {
this.logStatement("Undefined path for object: '" + qualifiedPath + "'", true);
}
}
return result;
}
/**
* Returns the destination directory. By default the current directory.
*
* @return class directory url
*/
protected URL destination() {
URL directory = (_configuration != null ? _configuration.destination() : null);
if (directory == null) {
try {
directory = (new File(System.getProperty("user.dir"))).toURL();
} catch (MalformedURLException exception) {
this.logStatement("Undefined user directory: '" + System.getProperty("user.dir") + "'", true);
System.exit(1);
}
}
return directory;
}
/**
* Returns the destination sub class directory. By default the same directory as the target directory.
*
* @return sub class directory url
*/
protected URL subClassDestination() {
URL directory = (_configuration != null ? _configuration.subClassDestination() : null);
if (directory == null)
directory = this.destination();
return directory;
}
/**
* Returns true if the verbose argument was set.
*
* @return true if in verbose mode
*/
public boolean verbose() {
return (_configuration != null ? _configuration.verbose().booleanValue() : false);
}
/**
* Returns true if the help argument was set.
*
* @return true is help is displayed
*/
public boolean help() {
return (_configuration != null ? _configuration.help().booleanValue() : false);
}
/**
* Returns true if the version argument was set.
*
* @return true if the version is to be displayed
*/
public boolean version() {
return (_configuration != null ? _configuration.version().booleanValue() : false);
}
/**
* Displays the help string
*/
public void showHelp() {
// We force the help display even if verbose is not set
this.logStatement(this.buildHelp(), true);
}
/**
* Helper function to build the help string
*
* @return help string
*/
protected String buildHelp() {
StringBuilder aLog = new StringBuilder();
this.buildHelpHeader(aLog);
this.buildHelpArguments(aLog);
this.buildHelpFooter(aLog);
return aLog.toString();
}
/**
* Prints the help header in the logs
*
* @param aLog
*/
protected void buildHelpHeader(StringBuilder aLog) {
aLog.append("Options:\n");
}
/**
* Prints the arguments in the logs
*
* @param aLog
*/
protected void buildHelpArguments(StringBuilder aLog) {
if (_configuration != null) {
_configuration.buildHelp(aLog);
}
}
/**
* Prints the help footer in the logs
*
* @param aLog
*/
protected void buildHelpFooter(StringBuilder aLog) {
aLog.append("");
}
/**
* Prints the generator version in the logs
*/
public void showVersion() {
// We force the version display even if verbose is not set
this.logStatement("unknown", true);
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder aLog = new StringBuilder();
aLog.append("<" + this.getClass().getName() + " ");
aLog.append("configuration: \n");
aLog.append(_configuration);
aLog.append(" >");
return aLog.toString();
}
}
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/JavaEOGenerator/listing16.html%3Fid%3DDTS10004471-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/JavaEOGenerator/listing16.html%3Fid%3DDTS10004471-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/JavaEOGenerator/listing16.html%3Fid%3DDTS10004471-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>